Get a Log

GET

requests

logs

{id}

curl --request GET \
  --url https://api.stackone.com/requests/logs/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": {
    "request_id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
    "event_datetime": "2021-01-01T00:00:00Z",
    "start_time": "2021-01-01T00:00:00Z",
    "end_time": "2021-01-01T00:00:00Z",
    "account_id": "45355976281015164504",
    "project_id": "dev-project-68574",
    "http_method": "get",
    "path": "/unified/hris/employees",
    "url": "https://api.stackone.com/unified/hris/employees?raw=false",
    "status": 200,
    "duration": 356,
    "success": true,
    "provider": "planday",
    "service": "hris",
    "resource": "employees",
    "child_resource": "time-off",
    "sub_resource": "documents",
    "action": "download",
    "is_worker": false,
    "source_type": "DASHBOARD",
    "source_value": "ACCOUNT_TESTER",
    "source_id": "1234567890",
    "request": {
      "id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
      "method": "get",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer token"
      },
      "url": {
        "url": "https://example.com/api/v1/resource",
        "hostname": "example.com",
        "path": "/api/v1/resource",
        "query_params": {
          "page": 1,
          "limit": 10
        }
      },
      "body": "<string>"
    },
    "response": {
      "status_code": 200,
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer token"
      },
      "body": "<string>",
      "custom_mapping_errors": [
        {
          "id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
          "message": "Invalid value",
          "targetField": "first_name"
        }
      ],
      "provider_errors": [
        {
          "status": 400,
          "url": "https://api.provider.com/v1/resource",
          "raw": {
            "message": "Invalid input parameters"
          },
          "headers": {
            "content-type": "application/json",
            "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
          }
        }
      ]
    },
    "step_requests": "Account Tester"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

string

required

Query Parameters

include

enum<string> | null

The include parameter allows you to include additional data in the response.

Available options:

step_logs,

advanced_logs

Example:

"step_logs"

Response

200

application/json

The log was retrieved.

data

object

required

data.request_id

string | null

The request ID

Example:

"adbf752f-6457-4ddd-89b3-98ae2252b83b"

data.event_datetime

string | null

The event ISO8601 date string

Example:

"2021-01-01T00:00:00Z"

data.start_time

string | null

The request start time ISO8601 date string

Example:

"2021-01-01T00:00:00Z"

data.end_time

string | null

The request end time ISO8601 date string

Example:

"2021-01-01T00:00:00Z"

data.account_id

string | null

The account ID of the request

Example:

"45355976281015164504"

data.project_id

string | null

The project ID of the request

Example:

"dev-project-68574"

data.http_method

string | null

The requested HTTP method

Example:

"get"

data.path

string | null

The requested path

Example:

"/unified/hris/employees"

data.url

string | null

The requested URL

Example:

"https://api.stackone.com/unified/hris/employees?raw=false"

data.status

number | null

The requests response status code

Example:

200

data.duration

number | null

The request duration in milliseconds

Example:

356

data.success

boolean | null

The request success flag

Example:

true

data.provider

string | null

The requested provider

Example:

"planday"

data.service

string | null

The requested service

Example:

"hris"

data.resource

string | null

The requested resource

Example:

"employees"

data.child_resource

string | null

The requested child resource

Example:

"time-off"

data.sub_resource

string | null

The requested sub resource

Example:

"documents"

data.action

string | null

The requested action

Example:

"download"

data.is_worker

boolean | null

The asynchronous worker flag

Example:

false

data.source_type

string | null

The requests source type

Example:

"DASHBOARD"

data.source_value

string | null

The requests source value

Example:

"ACCOUNT_TESTER"

data.source_id

string | null

The requests source ID

Example:

"1234567890"

data.request

object

The advanced log request data

data.request.id

string | null

The request ID

Example:

"adbf752f-6457-4ddd-89b3-98ae2252b83b"

data.request.method

string | null

The request method

Example:

"get"

data.request.headers

object | null

Example:

{
  "content-type": "application/json",
  "authorization": "Bearer token"
}

data.request.url

object

The request URL data

data.request.url.url

string | null

The request URL

Example:

"https://example.com/api/v1/resource"

data.request.url.hostname

string | null

The request URL hostname

Example:

"example.com"

data.request.url.path

string | null

The request path

Example:

"/api/v1/resource"

data.request.url.query_params

object | null

The request query parameters

Example:

{ "page": 1, "limit": 10 }

data.request.body

data.response

object

The advanced log response data

data.response.status_code

number | null

The response status code

Example:

200

data.response.headers

object | null

Example:

{
  "content-type": "application/json",
  "authorization": "Bearer token"
}

data.response.body

data.response.custom_mapping_errors

object[] | null

The custom mapping errors

data.response.provider_errors

object[] | null

The provider errors

data.response.provider_errors.status

number | null

HTTP status code of the provider error

Example:

400

data.response.provider_errors.url

string | null

URL that caused the error

Example:

"https://api.provider.com/v1/resource"

data.response.provider_errors.raw

object | null

Raw error response from the provider

Example:

{ "message": "Invalid input parameters" }

data.response.provider_errors.headers

object | null

Response headers

Example:

{
  "content-type": "application/json",
  "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}

data.step_requests

string[] | null

The list of provider requests

Example:

"Account Tester"

Was this page helpful?

Raise issue

Get meta information of the account List Logs

curl --request GET \
  --url https://api.stackone.com/requests/logs/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": {
    "request_id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
    "event_datetime": "2021-01-01T00:00:00Z",
    "start_time": "2021-01-01T00:00:00Z",
    "end_time": "2021-01-01T00:00:00Z",
    "account_id": "45355976281015164504",
    "project_id": "dev-project-68574",
    "http_method": "get",
    "path": "/unified/hris/employees",
    "url": "https://api.stackone.com/unified/hris/employees?raw=false",
    "status": 200,
    "duration": 356,
    "success": true,
    "provider": "planday",
    "service": "hris",
    "resource": "employees",
    "child_resource": "time-off",
    "sub_resource": "documents",
    "action": "download",
    "is_worker": false,
    "source_type": "DASHBOARD",
    "source_value": "ACCOUNT_TESTER",
    "source_id": "1234567890",
    "request": {
      "id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
      "method": "get",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer token"
      },
      "url": {
        "url": "https://example.com/api/v1/resource",
        "hostname": "example.com",
        "path": "/api/v1/resource",
        "query_params": {
          "page": 1,
          "limit": 10
        }
      },
      "body": "<string>"
    },
    "response": {
      "status_code": 200,
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer token"
      },
      "body": "<string>",
      "custom_mapping_errors": [
        {
          "id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
          "message": "Invalid value",
          "targetField": "first_name"
        }
      ],
      "provider_errors": [
        {
          "status": 400,
          "url": "https://api.provider.com/v1/resource",
          "raw": {
            "message": "Invalid input parameters"
          },
          "headers": {
            "content-type": "application/json",
            "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
          }
        }
      ]
    },
    "step_requests": "Account Tester"
  }
}

Platform API

API Reference

Authorizations

Path Parameters

Query Parameters

Response