ec90bd653983

latestOpenAPI 3.1.02026-08-1084330443.7 KB

Activities

Get Activities

Authorization scope: activity:list

Get summary of activities for the account and environment summarized by data flow.

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

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

group_idstring[] nullable

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

pageinteger

items_per_pageinteger

cache_context_idstring nullable

Cache context id is an internal query parameter for cache purposes

searchstring

Search for a specific river by river name

sort_by'river_name' | 'last_run' | 'units'

Activities sort properties in the UI.

sort_order'desc' | 'asc'

Sorting can be either asc or desc, used in the api-service

The river type

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

account_idstring required

The account id

environment_idstring required

The environment id

cache_context_idstring nullable required

Example response

{
  "items": [
    {
      "units": 2.1,
      "rpu": 2.1
    }
  ]
}