Reports

Get report results

Returns the results of the specified report.

get/analytics/v1/reports/{id}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/reports/{id}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

idstring required

Report ID. See Resource IDs.

Query parameters

timeRangestring
Example:P7D

An optional parameter to override the report time settings. Value should be represented in the format P[n]Y[n]M[n]D[n]. In the representations, the [n] is replaced by the value for each of the date and time elements that follow the [n].

startDatestring date
Example:2025-01-01

An optional parameter to override the report time settings. Must be provided together with endDate. Format: yyyy-mm-dd

endDatestring date
Example:2025-01-31

An optional parameter to override the report time settings. Must be provided together with startDate. Format: yyyy-mm-dd

Response

OK - The request succeeded.

idstring

Report ID.

reportNamestring

The name of the report.

ownerstring

Email address of the report owner.

type'custom' | 'preset'
createTimeinteger

The creation time of the report, in milliseconds since the epoch.

updateTimeinteger

The time when this report was last updated, in milliseconds since the epoch.

urlUIstring

The URL of the report in DoiT console.

Changes

No recorded changes to this operation across all 1 revision of this API.