v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

Shared Report

Generate shared report by ID

Response depends on report type and export type. Given example is for SUMMARY report and JSON exportType.

Shared report data on FREE subscription plan is limited to a maximum interval length of one month (31 days).

get/v1/shared-reports/{id}

Path parameters

idstring required

Represents a shared report identifier across the system.

Example:61794f784363c45af78e5555

Query parameters

dateRangeStartstring

Provide the start date in format YYYY-MM-DDTHH:MM:SS.ssssss. The system interprets this value based on the user's timezone (provided in the timeZone request parameter or the timezone configured in the user profile)

Example:2018-11-01T00:00:00

dateRangeEndstring

Provide the end date in format YYYY-MM-DDTHH:MM:SS.ssssss. The system interprets this value based on the user's timezone (provided in the timeZone request parameter or the timezone configured in the user profile)

Example:2018-11-30T23:59:59.999

sortOrderstring

Sort result in ascending or descending order

Example:ASCENDING

sortColumnstring

If provided, you'll get result sorted by sort column.

exportTypestring

Represents an export type of shared report

Example:JSON

pageinteger

Example:1

pageSizeinteger

Example:20