Download

    Try it · Sandbox

    Use a sandbox key. It is kept only for this browser tab and sent only to https://sandbox-api.zester.co.il/v2.

    Response
    Send the request to see the response.

    Audit

    The account's API request log, available on the Enterprise plan. Filter requests by date, API client and HTTP status code.

    The endpoints in this group are not yet available. This page documents the contract as currently defined.

    Endpoints

    The Audit request object

    Attributes

    request_idstringRequired
    timestampstring · date-timeRequired
    environmentstring
    Possible valueslivesandbox
    client_idstringRequired
    client_namestring
    key_idstring
    methodstringRequired
    pathstringRequired
    querystringNullable

    Query string of the request, with sensitive parameters redacted.

    statusintegerRequired
    error_codestringNullable
    latency_msinteger
    ipstring
    user_agentstringNullable
    request_bytesinteger
    response_bytesinteger
    scope_usedstringNullable
    The Audit request object
    {
  "request_id": "req_01J9KV1A2B",
  "timestamp": "2026-09-13T06:00:04+03:00",
  "environment": "live",
  "client_id": "cl_01J9KQ7X4M",
  "client_name": "Power BI הנהלת חשבונות",
  "key_id": "key_01J9KQ8Y5N",
  "method": "GET",
  "path": "/v2/documents",
  "query": "updated_since=2026-09-12T06:00:00+03:00&limit=200",
  "status": 200,
  "error_code": null,
  "latency_ms": 412,
  "ip": "203.0.113.24",
  "user_agent": "Microsoft.Data.Mashup (https://go.microsoft.com/fwlink/?LinkID=304225)",
  "request_bytes": 0,
  "response_bytes": 184220,
  "scope_used": "buyer.purchases:read"
}

    List request log entries

    GET/audit/requests
    • ScopeAny API key
    • Enterprise plan
    • Not yet available

    Query parameters

    cursorstring

    Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.

    limitinteger

    Default 50 · Min 1 · Max 200

    fromstring · date

    Start of the date range, inclusive, matched against the document date or the order date.

    tostring · date

    End of the date range, inclusive.

    client_idstring
    statusinteger

    HTTP status code to filter by.

    Responses

    200A page of request log entries.
    dataarray of AuditRequestRequired
    Show 17 child attributesHide child attributes
    request_idstringRequired
    timestampstring · date-timeRequired
    environmentstring
    Possible valueslivesandbox
    client_idstringRequired
    client_namestring
    key_idstring
    methodstringRequired
    pathstringRequired
    querystringNullable

    Query string of the request, with sensitive parameters redacted.

    statusintegerRequired
    error_codestringNullable
    latency_msinteger
    ipstring
    user_agentstringNullable
    request_bytesinteger
    response_bytesinteger
    scope_usedstringNullable
    next_cursorstringNullable
    has_morebooleanRequired
    403The credential is valid but is not allowed to make this request. The code is scope_missing, plan_required, ip_not_allowed or client_suspended.
    GET /audit/requests
    cURL
     
    curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/audit/requests?from=2026-09-13&to=2026-09-13&client_id=cl_01J9KQ7X4M&limit=3" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
    Response
    200
     
    {
  "data": [
    {
      "request_id": "req_01J9KV1A2B",
      "timestamp": "2026-09-13T06:00:04+03:00",
      "environment": "live",
      "client_id": "cl_01J9KQ7X4M",
      "client_name": "Power BI הנהלת חשבונות",
      "key_id": "key_01J9KQ8Y5N",
      "method": "GET",
      "path": "/v2/documents",
      "query": "updated_since=2026-09-12T06:00:00+03:00&limit=200",
      "status": 200,
      "error_code": null,
      "latency_ms": 412,
      "ip": "203.0.113.24",
      "user_agent": "Microsoft.Data.Mashup (https://go.microsoft.com/fwlink/?LinkID=304225)",
      "request_bytes": 0,
      "response_bytes": 184220,
      "scope_used": "buyer.purchases:read"
    },
    {
      "request_id": "req_01J9KV1B7C",
      "timestamp": "2026-09-13T06:00:05+03:00",
      "environment": "live",
      "client_id": "cl_01J9KQ7X4M",
      "client_name": "Power BI הנהלת חשבונות",
      "key_id": "key_01J9KQ8Y5N",
      "method": "GET",
      "path": "/v2/orders",
      "query": "updated_since=2026-09-12T06:00:00+03:00&limit=200",
      "status": 200,
      "error_code": null,
      "latency_ms": 238,
      "ip": "203.0.113.24",
      "user_agent": "Microsoft.Data.Mashup (https://go.microsoft.com/fwlink/?LinkID=304225)",
      "request_bytes": 0,
      "response_bytes": 96114,
      "scope_used": "buyer.purchases:read"
    },
    {
      "request_id": "req_01J9KV1C3D",
      "timestamp": "2026-09-13T06:00:05+03:00",
      "environment": "live",
      "client_id": "cl_01J9KQ7X4M",
      "client_name": "Power BI הנהלת חשבונות",
      "key_id": "key_01J9KQ8Y5N",
      "method": "GET",
      "path": "/v2/documents/5520931",
      "query": "expand=lines,files",
      "status": 429,
      "error_code": "rate_limited",
      "latency_ms": 3,
      "ip": "203.0.113.24",
      "user_agent": "Microsoft.Data.Mashup (https://go.microsoft.com/fwlink/?LinkID=304225)",
      "request_bytes": 0,
      "response_bytes": 318,
      "scope_used": "buyer.purchases:read"
    }
  ],
  "next_cursor": "eyJhZnRlciI6InJlcV8wMUo5S1YxQzNEIn0",
  "has_more": true
}