Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is
"REPORT_AVAILABLE"
.
JSON representation |
---|
{ "id": string, "reportId": string, "etag": string, "status": enum ( |
Fields | |
---|---|
id |
The unique ID of this report file. |
reportId |
The ID of the report this file was generated from. |
etag |
Etag of this resource. |
status |
The status of the report file. |
fileName |
The filename of the file. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
dateRange |
The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. |
format |
The output format of the report. Only available once the file is available. |
lastModifiedTime |
The timestamp in milliseconds since epoch when this file was last modified. |
urls |
The URLs where the completed report file can be downloaded. |
urls.browserUrl |
The URL for downloading the report data through a browser. |
urls.apiUrl |
The URL for downloading the report data through the API. |
Status
Enums | |
---|---|
PROCESSING |
|
REPORT_AVAILABLE |
|
FAILED |
|
CANCELLED |
DateRange
Represents a date range.
JSON representation |
---|
{
"startDate": string,
"endDate": string,
"relativeDateRange": enum ( |
Fields | |
---|---|
startDate |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". |
endDate |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". |
relativeDateRange |
The date range relative to the date of when the report is run. |
kind |
The kind of resource this is, in this case
. |
RelativeDateRange
Enums | |
---|---|
TODAY |
|
YESTERDAY |
|
WEEK_TO_DATE |
|
MONTH_TO_DATE |
|
QUARTER_TO_DATE |
|
YEAR_TO_DATE |
|
PREVIOUS_WEEK |
|
PREVIOUS_MONTH |
|
PREVIOUS_QUARTER |
|
PREVIOUS_YEAR |
|
LAST_7_DAYS |
|
LAST_30_DAYS |
|
LAST_90_DAYS |
|
LAST_365_DAYS |
|
LAST_24_MONTHS |
|
LAST_14_DAYS |
|
LAST_60_DAYS |
Format
Enums | |
---|---|
CSV |
|
EXCEL |