List Step Logs

GET /requests/logs/steps

List Step Logs

cURL

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

200

{
  "data": [
    {
      "request_id": "adbf752f-6457-4ddd-89b3-98ae2252b83b",
      "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,
      "id": "adbf752f-6457-4ddd-89b3-98ae2252b83b"
    }
  ],
  "next": "<string>"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

order_by · enum<string> | null

The field to order the results by.

Available options: provider, service, status, eventDatetime, duration,

Example:

"created_at"

order_direction · enum<string> | null

The direction to order the results by.

Available options: asc, desc,

Example:

"asc"

page_size · number | null

The number of results per page (default value is 25)

Required range: x <= 100

next · string | null

The unified cursor

filter · object

Filter parameters that allow greater customisation of the list response

Show child attributes

filter. account_ids · string | null

A comma-separated list of account IDs to filter the results by.

Example:

"45355976281015164504,45355976281015164505"

filter. start_date · string<date-time> | null

A ISO8601 date string to filter the results by start_date.

Example:

"2020-01-01T00:00:00.000Z"

filter. end_date · string<date-time> | null

A ISO8601 date string to filter the results by end_date.

Example:

"2020-01-01T00:00:00.000Z"

filter. request_ids · string | null

A comma-separated list of request IDs to filter the results by.

Example:

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

filter. http_methods · string | null

A comma-separated list of HTTP methods to filter the results by.

Example:

"GET,POST"

filter. providers · string | null

A comma-separated list of provider keys to filter the results by.

Example:

"ashby,greenhouse"

filter. services · string | null

A comma-separated list of services to filter the results by.

Example:

"hris,ats"

filter. resources · string | null

A comma-separated list of resources to filter the results by.

Example:

"employees,users"

filter. child_resources · string | null

A comma-separated list of child resources to filter the results by.

Example:

"documents,time-off"

filter. sub_resources · string | null

A comma-separated list of sub resources to filter the results by.

Example:

"documents,employees"

filter. actions · string | null

A comma-separated list of actions to filter the results by.

Example:

"download,upload"

filter. status_codes · string | null

A comma-separated list of status codes to filter the results by.

Example:

"200,400"

filter. success · boolean | null

A boolean value to filter the results by success or failure.

Example:

true

Response

200

application/json

The list of step logs was retrieved.

data · object[] · required

Show child attributes

data. request_id · string | null

The request ID

Example:

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

data. start_time · string<date-time> | null

The request start time ISO8601 date string

Example:

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

data. end_time · string<date-time> | 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. id · string | null

The provider request ID

Example:

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

next · string | null