Skip to main content
GET
List report runs

Authorizations

api_key
string
header
required

Query Parameters

configOId
string

List the runs of this one report config (rcfg_ prefix). Omit to list runs across every config of a group.

groupOId
string

The report group whose configs' runs to list (rcg_ prefix). Omit both this and configOId to default to the Weekly Beats group.

limit
number
default:20

Limit

Required range: x > 0
Example:

20

offset
number | null
default:0

Offset

Required range: x >= 0
Example:

0

customerScope
enum<string>

Return runs of this customer-scope view (NEW_CUSTOMERS / EXISTING_CUSTOMERS). Omitted or ALL returns the unscoped runs, which every workspace has.

Available options:
ALL,
NEW_CUSTOMERS,
EXISTING_CUSTOMERS

Response

200 - application/json

Report run list

_metadata
object
required
groupOId
string | null
required

The report group the runs were listed for; null only for a config that belongs to no group

groupTitle
string | null
required

Title of that report group

configOId
string | null
required

Set when one config was requested; null for a group-wide listing

configTitle
string | null
required

Title of that report config

data
object[]
required
total
number
required

Total runs matching the listing, across pages