Reports
Stay organized with collections
Save and categorize content based on your preferences.
A report
resource identifies a specific instance of a report. The resource identifies the period of time for which the report contains data as well as the URL from which the report can be downloaded.
Methods
The following table shows the methods that the API supports for report
resources.
Properties
The following table defines the properties that appear in this resource:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eA report resource represents a specific report instance, detailing the data period and the download URL.\u003c/p\u003e\n"],["\u003cp\u003eThe API supports \u003ccode\u003eget\u003c/code\u003e to retrieve metadata for a specific report and \u003ccode\u003elist\u003c/code\u003e to list reports generated for a given job.\u003c/p\u003e\n"],["\u003cp\u003eEach report has properties like \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003ejobId\u003c/code\u003e, \u003ccode\u003estartTime\u003c/code\u003e, \u003ccode\u003eendTime\u003c/code\u003e, \u003ccode\u003ecreateTime\u003c/code\u003e, \u003ccode\u003ejobExpireTime\u003c/code\u003e, and \u003ccode\u003edownloadUrl\u003c/code\u003e that identify it and specify its creation and data time.\u003c/p\u003e\n"],["\u003cp\u003eReports are associated with a specific job, and the \u003ccode\u003ejobExpireTime\u003c/code\u003e indicates when the job will stop generating new reports, in which case a replacement may be available.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edownloadUrl\u003c/code\u003e property is where the report can be retrieved, and it's possible to use gzip compression to reduce the bandwidth needed for the download, by adding the \u003ccode\u003eAccept-Encoding: gzip\u003c/code\u003e header.\u003c/p\u003e\n"]]],["The `report` resource identifies a specific report instance, its associated job, and the time period it covers. Key actions include retrieving metadata for a specific report using the `get` method and listing generated reports for a job with the `list` method. The resource includes properties like `id`, `jobId`, `startTime`, `endTime`, `createTime`, `jobExpireTime`, and `downloadUrl`. The `downloadUrl` allows for report retrieval via HTTP GET, supporting gzip compression for reduced bandwidth.\n"],null,["# Reports\n\nA **report** resource identifies a specific instance of a report. The resource identifies the period of time for which the report contains data as well as the URL from which the report can be downloaded.\n\nMethods\n-------\n\nThe following table shows the methods that the API supports for `report` resources.\n\n| Methods ||\n|-------------------------------------------------------------------|-------------------------------------------------------------------------|\n| [get](/youtube/reporting/v1/reference/rest/v1/jobs.reports/get) | Retrieves the metadata for a specific report. |\n| [list](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list) | Lists reports that have been generated for the specified reporting job. |\n\nJSON resource representation\n----------------------------\n\nThe JSON structure below shows the format of a `report` resource: \n\n```gdscript\n{\n \"#id\": string,\n \"#jobId\": string,\n \"#startTime\": timestamp,\n \"#endTime\": timestamp,\n \"#createTime\": timestamp,\n \"#jobExpireTime\": timestamp,\n \"#downloadUrl\": string\n}\n```\n\nProperties\n----------\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The ID that YouTube assigns to uniquely identify the report. Each report is associated with a single job, though a job may be associated with many report IDs. |\n| `jobId` | `string` The ID of the job that created this report. |\n| `startTime` | `timestamp` The start of the time period that the report instance covers. The inclusive value is a timestamp in RFC3339 UTC \"Zulu\" format, accurate to microseconds. Example: `\"2015-10-02T15:01:23.045678Z\"`. \u003cbr /\u003e |\n| `endTime` | `timestamp` The end of the time period that the report instance covers. The exclusive value is a timestamp in RFC3339 UTC \"Zulu\" format, accurate to microseconds. Example: `\"2015-10-02T15:01:23.045678Z\"`. \u003cbr /\u003e |\n| `createTime` | `timestamp` The date and time that the job was created. The property value is a timestamp in RFC3339 UTC \"Zulu\" format, accurate to microseconds. Example: `\"2015-10-02T15:01:23.045678Z\"`. \u003cbr /\u003e |\n| `jobExpireTime` | `timestamp` The date and time that the job that is associated with the report either expired or will expire. The property value is a timestamp in RFC3339 UTC \"Zulu\" format, accurate to microseconds. Example: `\"2015-10-02T15:01:23.045678Z\"`. This property has a value if either the report type that is associated with the report's job has been deprecated or reports generated for that job have not been downloaded for a prolonged period of time. The value marks the date after which YouTube will no longer generate new reports for the job. If you have a job that identifies an expiration date, you should update your system to stop requesting the report by that date. In some cases, a replacement report may be available. |\n| `downloadUrl` | `string` The URL from which the report can be downloaded. The property value has a maximum length of 1000 characters. To retrieve the report, send an HTTP `GET` request to this URL. In the request, set the `Authorization` HTTP Request header, using your [authorization token](/youtube/reporting/guides/authorization) as the header value. **Using gzip** You can reduce the bandwidth needed to download reports by enabling gzip compression on download requests. While your application will need additional CPU time to uncompress API responses, the benefit of consuming fewer network resources usually outweighs that cost. To receive a gzip-encoded response, set the `Accept-Encoding` HTTP request header to `gzip` as shown in the following example: ```text Accept-Encoding: gzip ``` |"]]
