Pipeline metrics and errors

Metrics and errors related to the pipelines, including both import/export processes and the sending or receiving of events within the pipelines.

Endpoints

Get metrics per dates

Retrieves metrics for pipelines aggregated by day for a time interval between specified start and end dates.

Request

:start
date Required
The starting date (inclusive) in ISO 8601 YYYY-MM-DD format, interpreted as UTC. It must be earlier than the end date.

The date must be no earlier than 1970-01-01 and no later than 2262-04-11.
:end
date Required
The ending date (exclusive) in ISO 8601 YYYY-MM-DD format, interpreted as UTC. It must be later than the start date.

The date must be no earlier than 1970-01-01 and no later than 2262-04-11.
pipelines
array of int Required
The IDs of the pipelines for which metrics should be returned. At least one pipeline must be provided. The request does not fail if a pipeline does not exist.

Response

start
datetime
The starting date (inclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDT00:00:00Z.
end
datetime
The ending date (exclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDT00:00:00Z.
passed
array of array of int
The number of users or events that successfully passed each step on each hour within the start and end dates.
failed
array of array of int
The number of users or events that failed at each step on each hour within the start and end dates.

GET /v1/pipelines/metrics/dates/:start/:end

curl -G https://example.com/v1/pipelines/metrics/dates/2026-01-15/2026-02-30 \
  -H "Authorization: Bearer api_xxxxxxx" \
  -d "pipelines=705981339,1360924687"

Response

{
  "start": "2026-01-15T00:00:00Z",
  "end": "2026-02-30T00:00:00Z",
  "passed": [
    [
      6029,
      6029,
      5974,
      5974,
      5974,
      5974
    ]
  ],
  "failed": [
    [
      0,
      0,
      55,
      0,
      0,
      0
    ]
  ]
}

Errors

404

workspace does not exist

Get metrics per day

Retrieves metrics for pipelines for a specified number of days up to the current time.

Request

:days
int Required
The number of days, ranging from 1 to 30.
pipelines
array of int Required
The IDs of the pipelines for which metrics should be returned. At least one pipeline must be provided. The request does not fail if a pipeline does not exist.

Response

start
datetime
The starting date (inclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDT00:00:00Z.
end
datetime
The ending date (exclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDT00:00:00Z.
passed
array of array of int
The number of users or events that successfully passed each step on each hour within the start and end dates.
failed
array of array of int
The number of users or events that failed at each step on each hour within the start and end dates.

GET /v1/pipelines/metrics/days/:days

curl -G https://example.com/v1/pipelines/metrics/days/7 \
  -H "Authorization: Bearer api_xxxxxxx" \
  -d "pipelines=705981339,1360924687"

Response

{
  "start": "2026-01-15T00:00:00Z",
  "end": "2026-02-22T00:00:00Z",
  "passed": [
    [
      6029,
      6029,
      5974,
      5974,
      5974,
      5974
    ]
  ],
  "failed": [
    [
      0,
      0,
      55,
      0,
      0,
      0
    ]
  ]
}

Errors

404

workspace does not exist

Get metrics per hour

Retrieves metrics for pipelines for a specified number of hours up to the current time.

Request

:hours
int Required
The number of hours, ranging from 1 to 48.
pipelines
array of int Required
The IDs of the pipelines for which metrics should be returned. At least one pipeline must be provided. The request does not fail if a pipeline does not exist.

Response

start
datetime
The starting time (inclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDTHH:00:00Z.
end
datetime
The ending time (exclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDTHH:00:00Z.
passed
array of array of int
The number of users or events that successfully passed each step on each hour within the start and end dates.
failed
array of array of int
The number of users or events that failed at each step on each hour within the start and end dates.

GET /v1/pipelines/metrics/hours/:hours

curl -G https://example.com/v1/pipelines/metrics/hours/12 \
  -H "Authorization: Bearer api_xxxxxxx" \
  -d "pipelines=705981339,1360924687"

Response

{
  "start": "2026-01-15T09:00:00Z",
  "end": "2026-01-15T21:00:00Z",
  "passed": [
    [
      6029,
      6029,
      5974,
      5974,
      5974,
      5974
    ]
  ],
  "failed": [
    [
      0,
      0,
      55,
      0,
      0,
      0
    ]
  ]
}

Errors

404

workspace does not exist

Get metrics per minute

Retrieves metrics for pipelines for a specified number of minutes up to the current time.

Request

:minutes
int Required
The number of minutes, ranging from 1 to 60. By default, it is 60.
pipelines
array of int Required
The IDs of the pipelines for which metrics should be returned. At least one pipeline must be provided. The request does not fail if a pipeline does not exist.

Response

start
datetime
The starting time (inclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDTHH:mm:00Z.
end
datetime
The ending time (exclusive), returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDTHH:mm:00Z.
passed
array of array of int
The number of users or events that successfully passed each step on each hour within the start and end dates.
failed
array of array of int
The number of users or events that failed at each step on each hour within the start and end dates.

GET /v1/pipelines/metrics/minutes/:minutes

curl -G https://example.com/v1/pipelines/metrics/minutes/15 \
  -H "Authorization: Bearer api_xxxxxxx" \
  -d "pipelines=705981339,1360924687"

Response

{
  "start": "2026-01-02T09:49:00Z",
  "end": "2026-01-02T10:04:00Z",
  "passed": [
    [
      6029,
      6029,
      5974,
      5974,
      5974,
      5974
    ]
  ],
  "failed": [
    [
      0,
      0,
      55,
      0,
      0,
      0
    ]
  ]
}

Errors

404

workspace does not exist

Get errors

Retrieves errors for pipelines for a time interval between specified start and end dates.

Request

:start
datetime Required
The starting time (inclusive) in ISO 8601 YYYY-MM-DDTHH:mm:ss format, interpreted as UTC. It must be earlier than the end time.

The time must be no earlier than 1970-01-01 00:00:00 and no later than 2262-04-11 23:47:00.
:end
datetime Required
The ending time (exclusive) in ISO 8601 YYYY-MM-DDTHH:mm:ss format, interpreted as UTC. It must be later than the start time.

The time must be no earlier than 1970-01-01 00:00:00 and no later than 2262-04-11 23:47:00.
pipelines
array of int Required
The IDs of the pipelines for which errors should be returned. At least one pipeline must be provided. The request does not fail if a pipeline does not exist within the workspace.

The pipelines can be specified in the query string in this way:

pipelines=705981339&pipelines=1360924687
step
string
The pipeline step for which errors should be returned. If no step is specified, errors will be returned for all steps.
Possible values: "Receive", "InputValidation", "Filter", "Transformation", "OutputValidation" or "Finalize".
first
int
The number of errors to skip before starting to return errors. It must be between 0 and 9999, with a default value of 0.
limit
int
The maximum number of errors to return. It must be between 1 and 100, with a default value of 100.

Response

errors
array of object
The errors that occurred during the specified period for the provided pipelines.
- pipeline
  int
  The pipeline in which the error occurred.
- step
  string
  The step where the error occurred.
  Possible values: "Receive", "InputValidation", "Filter", "Transformation", "OutputValidation" or "Finalize".
- count
  int
  The number of occurrences of the error within the specified period.
- message
  string
  The error message.
- lastOccurred
  datetime
  The time of the last occurrence of the error within the specified period, returned as an ISO 8601 UTC timestamp in the format YYYY-MM-DDTHH:mm:00Z.

GET /v1/pipelines/errors/:start/:end

curl -G https://example.com/v1/pipelines/errors/2026-01-02T09%3A49%3A12/2026-01-02T12%3A30%3A00 \
  -H "Authorization: Bearer api_xxxxxxx" \
  -d "pipelines=705981339,1360924687"

Response

{
  "errors": [
    {
      "pipeline": 705981339,
      "step": "Transformation",
      "count": 2,
      "message": "property «email» has a value that is not of type «string»",
      "lastOccurred": "2026-01-02T10:25:00Z"
    }
  ]
}

Errors

404

workspace does not exist

Metrics and errors

Get metrics per dates

Request

:start

:end

pipelines

Response

start

end

passed

failed

Get metrics per day

Request

:days

pipelines

Response

start

end

passed

failed

Get metrics per hour

Request

:hours

pipelines

Response

start

end

passed

failed

Get metrics per minute

Request

:minutes

pipelines

Response

start

end

passed

failed

Get errors

Request

:start

:end

pipelines

step

first

limit

Response

errors

pipeline

step

count

message

lastOccurred