/v1/jobs/{jobId}/reports

GET

jobs

Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://youtubereporting.googleapis.com//v1/jobs//reports'

Response Example

{
    "nextPageToken": "string",
    "reports": [
        {
            "createTime": "string",
            "downloadUrl": "string",
            "endTime": "string",
            "id": "string",
            "jobExpireTime": "string",
            "jobId": "string",
            "startTime": "string"
        }
    ]
}

Request

Path Params

jobId

string

required

The ID of the job.

Query Params

createdAfter

string

optional

If set, only reports created after the specified date/time are returned.

onBehalfOfContentOwner

string

optional

The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

pageSize

integer

optional

Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.

pageToken

string

optional

A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the ListReports method.

startTimeAtOrAfter

string

optional

If set, only reports whose start time is greater than or equal the specified date/time are returned.

startTimeBefore

string

optional

If set, only reports whose start time is smaller than the specified date/time are returned.

Responses

🟢200Successful response

application/json

Body

Response message for ReportingService.ListReports.

nextPageToken

string

optional

A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to ListReports method to retrieve the next page of results.

reports

array[object (Report) {7}]

optional

The list of report types.

createTime

string <google-datetime>

optional

The date/time when this report was created.

downloadUrl

string

optional

The URL from which the report can be downloaded (max. 1000 characters).

endTime

string <google-datetime>

optional

The end of the time period that the report instance covers. The value is exclusive.

string

optional

The server-generated ID of the report.

jobExpireTime

string <google-datetime>

optional

The date/time when the job this report belongs to will expire/expired.

jobId

string

optional

The ID of the job that created this report.

startTime

string <google-datetime>

optional

The start of the time period that the report instance covers. The value is inclusive.

Modified at 2023-08-15 05:44:52

/v1/jobs/{jobId}

/v1/jobs/{jobId}/reports/{reportId}