GET
/
requests
/
logs
/
steps
curl --request GET \
  --url https://api.stackone.com/requests/logs/steps \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": "<string>",
  "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",
      "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"
            }
          }
        ]
      }
    }
  ]
}

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

​
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"

​
filter
object | null

Filter parameters that allow greater customisation of the list response

Response

200
application/json
The list of step logs was retrieved.

The response is of type object.