List logs for integration

GET 
https://euwest.api.elasticpath.com/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 [
idstring
A unique identifier of an integration whose logs you want to view.
Example: ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849
typestring
This represents the type of resource object being returned. Always integration.
Possible values: [integration]
Default value: integration
Example: integration
succeededboolean
Whether the integration was successful.
Example: true
attemptinteger
The number of attempts made to process the integration.
Example: 1
bodystring
The response returned from the integration.
Example: Not Found
status_codeinteger
The status code returned from the integration.
Example: 404
error_detailstring
The reason why the integration failed.
Example: Received a status code outside of 2xx range - treating webhook as a fail
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
idstring
The ID of the integration processed.
Example: ff8634a8-a89e-4eac-baab-9b7b8c4f8720
typestring
This represents the resource type of the object being returned. Always integration.
Example: integration
job object
data object
idstring
The ID of the integration job processed.
Example: ff8634a8-a89e-4eac-baab-9b7b8c4f8720
typestring
This represents the resource type of the object being returned. Always integration-job.
Example: job
]
meta object
limitinteger
The maximum number of records per page for a response. You can set this value up to 100.
Example: 100
offsetinteger
The current offset by number of records, not pages. Offset is zero-based.
Example: 0
currentinteger
The current page.
Example: 1
totalinteger
The total page count.
Example: 1
results object
The results for this response for the entire collection.
totalinteger
The total number of records for this response for the entire collection.
Example: 1

Example (auto)

{
  "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 [
statusint
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
]

Example (auto)

{
  "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 [
statusint
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
]

Example (auto)

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

internal-server-error

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

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/integrations/:integration_uuid/logs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

integration_uuid — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!