Service

Query service logs

Queries service log entries associated with this project.

Note: Service logs are automatically deleted and no longer available via the API after approximately one month.

get/v1/projects/{project_id}/service_logs

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/service_logs
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Query parameters

service_idstring

ID of Service

Filter logs generated by a particular service

message_idstring

ID of Message

Filter service logs related to a particular message

contact_idstring

ID of Contact

Filter service logs related to a particular contact. Ignored if using the message_id parameter.

time_createdinteger

Unix timestamp in seconds

Filter service logs by the time they were created

execution_statsboolean

Show detailed execution stats for each log entry, if available.

sort_dir'asc' | 'desc'

Sort the results in ascending or descending order

page_sizeinteger

Number of results returned per page (max 500)

offsetinteger

Number of items to skip from beginning of result set

markerstring

'next_marker' property returned by a previous call to this API method, indicating where the next page of results should start.

countboolean

If true, the API will return the count of items matching the filter, instead of the items themselves

Response

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

dataobject[]

Array of results (omitted when count=1)

truncatedboolean

True if there are more results

next_markerstring

Marker for pagination

page_sizeinteger

Number of results per page

sort_dir'asc' | 'desc'

Sort direction

countinteger

Total count of matching items (only when count=1 parameter is provided)

Changes

No recorded changes to this operation across all 1 revision of this API.