Skip to main content

Fetch multiple summary reports

POST 

/bv/analytics/v1/summary/reports:batch-get

Fetch multiple customized summary reports by specifying various parameters.


  • Returns a 400/BadRequest error if the request is invalid.
  • Returns a 404/NotFound error if the specified report is not found.
  • Returns a 500/Internal Server Error error if any internal error occurs.

Request

Header Parameters

    x-bv-org-id stringrequired

    To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Body

required
    reports object[]
  • Array [
  • id stringrequired

    Required. The uuid of the report.

    dimension_with_condition objectrequired

    Required. The dimension with condition of the report.

    dimension stringrequired

    Possible values: [SUMMARY_REPORT_DIMENSION_METRICS]

    Required. The dimension of the report.

    interval object

    The highest precision of the interval is only to the day of the organization's time zone.

    start_time date-time

    Optional. Inclusive start of the interval.

    If specified, a Timestamp matching this interval will have to be the same or after the start.

    end_time date-time

    Optional. Exclusive end of the interval.

    If specified, a Timestamp matching this interval will have to be before the end.

  • ]

Responses

A successful response.

Schema
    reports object[]
  • Array [
  • id stringrequired

    Required. The uuid of the report.

    status string

    Possible values: [EVENT_REPORT_STATUS_RUNNING, EVENT_REPORT_STATUS_SUCCEEDED, EVENT_REPORT_STATUS_FAILED]

    Output only. The current status of the report.

    uri string

    Output only. The download URI of the report.

    dimension_with_condition objectrequired

    Required. The dimension with condition of the report.

    dimension stringrequired

    Possible values: [SUMMARY_REPORT_DIMENSION_METRICS]

    Required. The dimension of the report.

    interval object

    The highest precision of the interval is only to the day of the organization's time zone.

    start_time date-time

    Optional. Inclusive start of the interval.

    If specified, a Timestamp matching this interval will have to be the same or after the start.

    end_time date-time

    Optional. Exclusive end of the interval.

    If specified, a Timestamp matching this interval will have to be before the end.

    error_info object

    Output only. The information will be shown if the report is facing an unexpected error.

    reason string

    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

    domain string

    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

    metadata object

    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

    property name* string
  • ]
Loading...