Skip to main content
GET
/
api
/
v1
/
analytics
/
runs
/
summary
Get runs summary for a date range
curl --request GET \
  --url https://dashboard.sequentum.com/api/v1/analytics/runs/summary \
  --header 'Authorization: Bearer <token>'
{
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "totalRuns": 123,
  "completedRuns": 123,
  "failedRuns": 123,
  "completedWithErrorsRuns": 123,
  "runningRuns": 123,
  "queuedRuns": 123,
  "stoppedRuns": 123,
  "failedRunDetails": [
    {
      "runId": 123,
      "agentId": 123,
      "agentName": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "status": 0,
      "errorMessage": "<string>",
      "spaceId": 123,
      "spaceName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.sequentum.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Query Parameters

startDate
string<date-time>

Start date for the range (ISO format, defaults to yesterday)

endDate
string<date-time>

End date for the range (ISO format, defaults to now)

status
enum<integer>

Optional: Filter by specific status (Failed, Completed, etc.)

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
includeDetails
boolean
default:true

Whether to include details of failed runs (default: true)

Response

Returns the runs summary

Response model for runs summary

startDate
string<date-time>

Start date of the range

endDate
string<date-time>

End date of the range

totalRuns
integer<int32>

Total number of runs in the date range

completedRuns
integer<int32>

Number of completed runs

failedRuns
integer<int32>

Number of failed runs

completedWithErrorsRuns
integer<int32>

Number of runs completed with errors

runningRuns
integer<int32>

Number of currently running runs

queuedRuns
integer<int32>

Number of queued runs

stoppedRuns
integer<int32>

Number of stopped runs

failedRunDetails
object[] | null

Details of failed runs (if requested)