Chilkat Online Tools

delphiAx / Support API / Export Audit Logs

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

http.SetRequestHeader('Accept','application/json');

resp := http.QuickRequest('POST','https://example.zendesk.com/api/v2/audit_logs/export?filter[source_type]=<string>&filter[source_id]=<integer>&filter[actor_id]=<integer>&filter[ip_address]=<string>&filter[created_at]=<string>&filter[action]=<string>');
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/audit_logs/export?filter[source_type]=<string>&filter[source_id]=<integer>&filter[actor_id]=<integer>&filter[ip_address]=<string>&filter[created_at]=<string>&filter[action]=<string>

Postman Collection Item JSON

{
  "name": "Export Audit Logs",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/audit_logs/export?filter[source_type]=<string>&filter[source_id]=<integer>&filter[actor_id]=<integer>&filter[ip_address]=<string>&filter[created_at]=<string>&filter[action]=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "audit_logs",
        "export"
      ],
      "query": [
        {
          "key": "filter[source_type]",
          "value": "<string>",
          "description": "Filter audit logs by the source type. For example, user or rule"
        },
        {
          "key": "filter[source_id]",
          "value": "<integer>",
          "description": "Filter audit logs by the source id. Requires `filter[source_type]` to also be set."
        },
        {
          "key": "filter[actor_id]",
          "value": "<integer>",
          "description": "Filter audit logs by the actor id"
        },
        {
          "key": "filter[ip_address]",
          "value": "<string>",
          "description": "Filter audit logs by the ip address"
        },
        {
          "key": "filter[created_at]",
          "value": "<string>",
          "description": "Filter audit logs by the time of creation"
        },
        {
          "key": "filter[action]",
          "value": "<string>",
          "description": "Filter audit logs by the action"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins on accounts that have audit log access\n"
  },
  "response": [
    {
      "name": "Accepted description",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/audit_logs/export?filter[source_type]=<string>&filter[source_id]=<integer>&filter[actor_id]=<integer>&filter[ip_address]=<string>&filter[created_at]=<string>&filter[action]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "audit_logs",
            "export"
          ],
          "query": [
            {
              "key": "filter[source_type]",
              "value": "<string>",
              "description": "Filter audit logs by the source type. For example, user or rule"
            },
            {
              "key": "filter[source_id]",
              "value": "<integer>",
              "description": "Filter audit logs by the source id. Requires `filter[source_type]` to also be set."
            },
            {
              "key": "filter[actor_id]",
              "value": "<integer>",
              "description": "Filter audit logs by the actor id"
            },
            {
              "key": "filter[ip_address]",
              "value": "<string>",
              "description": "Filter audit logs by the ip address"
            },
            {
              "key": "filter[created_at]",
              "value": "<string>",
              "description": "Filter audit logs by the time of creation"
            },
            {
              "key": "filter[action]",
              "value": "<string>",
              "description": "Filter audit logs by the action"
            }
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "<string>"
    }
  ]
}