Skip to main content
GET
/
logs
Get Logs
curl --request GET \
  --url https://api.cozmox.ai/logs \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "time": "<string>",
      "orgId": "<string>",
      "type": "API",
      "webhookType": "<string>",
      "resource": "org",
      "requestDurationSeconds": 1,
      "requestStartedAt": "<string>",
      "requestFinishedAt": "<string>",
      "requestBody": {},
      "requestHttpMethod": "POST",
      "requestUrl": "<string>",
      "requestPath": "<string>",
      "requestQuery": "<string>",
      "responseHttpCode": 123,
      "requestIpAddress": "<string>",
      "requestOrigin": "<string>",
      "responseBody": {},
      "requestHeaders": {},
      "error": {
        "message": "<string>"
      },
      "assistantId": "<string>",
      "phoneNumberId": "<string>",
      "customerId": "<string>",
      "squadId": "<string>",
      "callId": "<string>"
    }
  ],
  "metadata": {
    "itemsPerPage": 123,
    "totalItems": 123,
    "currentPage": 123
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard.

Query Parameters

​
type
enum<string>

This is the type of the log.

Available options:
API,
Webhook,
Call,
Provider
​
webhookType
string

This is the type of the webhook, given the log is from a webhook.

​
assistantId
string

This is the ID of the assistant.

​
phoneNumberId
string

This is the ID of the phone number.

​
customerId
string

This is the ID of the customer.

​
squadId
string

This is the ID of the squad.

​
callId
string

This is the ID of the call.

​
page
number

This is the page number to return. Defaults to 1.

Required range: x >= 1
​
sortOrder
enum<string>

This is the sort order for pagination. Defaults to 'DESC'.

Available options:
ASC,
DESC
​
limit
number

This is the maximum number of items to return. Defaults to 100.

Required range: 0 <= x <= 1000
​
createdAtGt
string<date-time>

This will return items where the createdAt is greater than the specified value.

​
createdAtLt
string<date-time>

This will return items where the createdAt is less than the specified value.

​
createdAtGe
string<date-time>

This will return items where the createdAt is greater than or equal to the specified value.

​
createdAtLe
string<date-time>

This will return items where the createdAt is less than or equal to the specified value.

​
updatedAtGt
string<date-time>

This will return items where the updatedAt is greater than the specified value.

​
updatedAtLt
string<date-time>

This will return items where the updatedAt is less than the specified value.

​
updatedAtGe
string<date-time>

This will return items where the updatedAt is greater than or equal to the specified value.

​
updatedAtLe
string<date-time>

This will return items where the updatedAt is less than or equal to the specified value.

Response

200 - application/json
​
results
object[]
required
​
metadata
object
required