Report

List definition

Any report resource returned by a list request will contain the following properties:

{
    "kind": "report",
    "id": string,
    "uri": string,
    "url": string,
    "qualifiedReference": string,
    "scopedReference": string,
    "referenceId": string,
    "createdAt": integer,
    "updatedAt": integer,
    "name": string,
}

Documentation

Fields	Description
kind	string The resource type. Will always be "report".
id	string A unique, persistent identifier for the report.
uri	string The fully qualified URI of this report, for use in generating calls to this API. For example, /reports/demo.my_report:prpw
url	string The report's discoverable url.
qualifiedReference	string The fully qualified reference to this report, for use in the report.download API endpoint For example, demo.my_report:prpw
scopedReference	string The canonical reference for the report, without any qualifiers. E.g., my_report:prpw
referenceId	string A persistent, 4-character identifier for this report. Will always be unique across all reports within an organization / institution.
createdAt	integer When the report was created. Stored as milliseconds since the epoch (1970-01-01).
updatedAt	integer When the report was last updated. Stored as milliseconds since the epoch (1970-01-01).
name	string The name of the report. Will only contain alphanumeric and underscore characters.