Skip to main content

Report Object

Reports are groups of API Calls and Locations, they are used to show statistics at specific times. This object defines how they are configured.

NameDescriptionRequired?
metaSee belowY
reportSee belowY

Section: meta

NameDescriptionRequired?
nameName of call, for your referenceYes
descriptionDescription of call, for your referenceNo
tagsList of tags for the call, for your referenceNo
ownerThe ID of the Report OwnerNo - read-only
NameDescriptionRequired?
publicIs the report with the APImetrics community?N
orgIs the report shared with your Organization?N

Section: groups

The section "groups" is a list of the following objects:

NameDescriptionRequired?
nameGroup NameY
rowsSee belowN

Section: rows

The section "rows" is a list of the following objects:

NameDescriptionRequired?
call_idThe ID of the API Call you want to see the stats for.Y
location_idThe ID of the deployed location you want to see the stats for.Y