List logs for integration

GET 
/integrations/:integration_uuid/logs

Returns the logs for the given integration UUID.

Request

Path Parameters

integration_uuid stringrequired

The unique identifier of the integration.

Responses

200

Success. Returns a list of integration logs.

application/json

Schema

Schema

data IntegrationLog[]
Array [
id string
A unique identifier of an integration whose logs you want to view.
type string
Possible values: [integration]
Default value: integration
This represents the type of resource object being returned. Always integration.
succeeded boolean
Whether the integration was successful.
attempt integer
The number of attempts made to process the integration.
body string
The response returned from the integration.
status_code integer
The status code returned from the integration.
error_detail string
The reason why the integration failed.
relationships object
Relationships are established between different integration entities. For example, a log and an integration job are related to an integration.
integration object
data object
id string
The ID of the integration processed.
type string
This represents the resource type of the object being returned. Always integration.
job object
data object
id string
The ID of the integration job processed.
type string
This represents the resource type of the object being returned. Always integration-job.
]
meta object

limit integer

The maximum number of records per page for a response. You can set this value up to 100.

offset integer

The current offset by number of records, not pages. Offset is zero-based.

current integer

The current page.

total integer

The total page count.

results object

The results for this response for the entire collection.

total integer

The total number of records for this response for the entire collection.

Example (from schema)

{
  "data": [
    {
      "id": "ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849",
      "type": "integration",
      "succeeded": true,
      "attempt": 1,
      "body": "Not Found",
      "status_code": 404,
      "error_detail": "Received a status code outside of 2xx range - treating webhook as a fail",
      "relationships": {
        "integration": {
          "data": {
            "id": "ff8634a8-a89e-4eac-baab-9b7b8c4f8720",
            "type": "integration"
          }
        },
        "job": {
          "data": {
            "id": "ff8634a8-a89e-4eac-baab-9b7b8c4f8720",
            "type": "job"
          }
        }
      }
    }
  ],
  "meta": {
    "limit": 100,
    "offset": 0,
    "current": 1,
    "total": 1
  },
  "results": {
    "total": 1
  }
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status int
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": 404,
      "detail": "The resource could not be found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status int
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": 500
    }
  ]
}

Loading...