v3

latestSwagger 2.02026-08-067506752.0 MB
job

Find jobs in the organization returned as a time-series

get/v2/org/{orgId}/job/timeseries

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

scenarioIdstring

Scenario id to query

startDatestring date

Start date to start from (inclusive)

endDatestring date

End date to start from (exclusive)

interval'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'FISCAL_QUARTER' | 'YEAR' | 'FISCAL_YEAR'

Interval to separate by (default is 'month')

qstring

Search query

fieldsstring

Fields to retrieve, comma-separated

exprstring

Expression to calculate as-of the end of each interval

formatstring

Data format to use; default is json, can also use json-extended or json-readable

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}