Sign in
Survey data - Rest Services

List logs of an external services endpoints accessible to requesting user

⚠️ The page query parameter is deprecated, use start and limit instead.

Where:

  • asset_uid - is the unique identifier of a specific asset
  • hook_uid - is the unique identifier of a specific external service
  • uid - is the unique identifier of a specific log

Use the status query parameter to filter logs by numeric status:

  • status=0: hook has failed after exhausting all retries
  • status=1: hook is still pending
  • status=2: hook has succeeded

Use the start_date and end_date query parameters to filter logs by date range, providing ISO-8601 date strings (e.g. '2022-01-14', '2022-01-21 06:51:04', '2022-01-21T06:51:08.144004+02:00'). Time zone is assumed to be UTC. If provided, it needs to be in '+00:00' format ('Z' is not supported). Watch out for url encoding for the '+' character (%2B).

Note that start_date is inclusive, while end_date is exclusive.

get/api/v2/assets/{uid_asset}/hooks/{uid_hook}/logs/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_assetstring required

UID of the parent assets

uid_hookstring required

UID of the parent hook

Query parameters

end_datestring date-time
limitinteger

Number of results to return per page. Use with start.

offsetinteger

Deprecated alias of start.

startinteger

The initial index from which to return the results. Use with limit.

start_datestring date-time
status0 | 1 | 2 | 3
  • 0 - failed
  • 1 - pending
  • 3 - processing
  • 2 - success

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "https://kf.kobotoolbox.org/api-endpoint/?start=400&limit=100",
  "previous": "https://kf.kobotoolbox.org/api-endpoint/?start=200&limit=100",
  "results": [
    {
      "url": "https://kf.kobotoolbox.org/api/v2/assets/aTPPUDScaFZkvBzd8FyK4Q/hooks/hsw3Ec5vz7Lqg7TrwrxdaS/logs/hl8Ldv5m84SBpU5UB5J7QBD/"
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.