Sign in

ec90bd653983

latestOpenAPI 3.1.02026-08-1084330443.7 KB
Activities

Get Activities Statistic

Authorization scope: activity:list

Get environment's activity statistics.

The statistics include how many units(RPU) were consumed, and how many runs ended with each status.

get/v1/accounts/{account_id}/environments/{environment_id}/activities_statistics

Path parameters

account_idstring required
environment_idstring required

Query parameters

start_timestring date-time required

The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm

Example:2020-01-01T12:00:00

The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm

end_timestring date-time required

The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm

Example:2020-01-01T12:00:00

The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm

statusActivityStatusEnum[] nullable

A list of statuses to filter

A list of statuses to filter

group_idstring[] nullable

The ID of the group to filter

The ID of the group to filter

is_scheduled'true' | 'false'

Schedule can be either True or False (enabled or disabled)

A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned

searchstring

Get statistics for rivers that has the search query in their name

Get statistics for rivers that has the search query in their name

The river type

Response

Successful Response

account_idstring required
environment_idstring required
total_unitsnumber required

Total RPU (units)

total_rpunumber required

Total RPU

runninginteger required
canceledinteger required
pendinginteger required
failedinteger required
succeededinteger required
skippedinteger required

Example response

{
  "total_units": 2.1,
  "total_rpu": 2.1
}