Creates overview report

POST 
https://api.one.blendvision.com/bv/analytics/v1/overviews/reports

Generates an customized overview report by specifying various parameters.

---

• Returns a 400/BadRequest error if the request is invalid.
• 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.

application/json

Body

required

dimension_with_conditions object[]required
Required. The dimension with condition of the report.
Array [
dimension stringrequired
Possible values: [OVERVIEW_REPORT_DIMENSION_WATCH_TIME]
Required. The dimension of the report.
group_by_fields string[]required
Possible values: [GROUP_BY_FIELD_WATCH_TIMESTAMP, GROUP_BY_FIELD_CUSTOMER_ID, GROUP_BY_FIELD_DEVICE_ID, GROUP_BY_FIELD_DEVICE_OS, GROUP_BY_FIELD_GEO_REGION]
Required. If there is no need to aggregate, use an empty array.
filter object
The filter of the report.
start_time date-timerequired
end_time date-timerequired
]

Responses

200

A successful response.

application/json

Schema

Schema

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: [OVERVIEW_REPORT_DIMENSION_WATCH_TIME]
Required. The dimension of the report.
group_by_fields string[]required
Possible values: [GROUP_BY_FIELD_WATCH_TIMESTAMP, GROUP_BY_FIELD_CUSTOMER_ID, GROUP_BY_FIELD_DEVICE_ID, GROUP_BY_FIELD_DEVICE_OS, GROUP_BY_FIELD_GEO_REGION]
Required. If there is no need to aggregate, use an empty array.
filter object
The filter of the report.
start_time date-timerequired
end_time date-timerequired
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.
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
]

Example (from schema)

{
  "reports": [
    {
      "id": "string",
      "dimension_with_condition": {
        "dimension": "OVERVIEW_REPORT_DIMENSION_WATCH_TIME",
        "group_by_fields": [
          "GROUP_BY_FIELD_WATCH_TIMESTAMP"
        ],
        "filter": {
          "start_time": "2024-07-29T15:51:28.071Z",
          "end_time": "2024-07-29T15:51:28.071Z"
        }
      },
      "status": "EVENT_REPORT_STATUS_RUNNING",
      "uri": "string",
      "error_info": {
        "reason": "string",
        "domain": "string",
        "metadata": {}
      }
    }
  ]
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Authorization: authorization

name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header

• curl
• python
• go
• nodejs
• php

• CURL

curl -L 'https://api.one.blendvision.com/bv/analytics/v1/overviews/reports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>' \
-d '{
  "dimension_with_conditions": [
    {
      "dimension": "OVERVIEW_REPORT_DIMENSION_WATCH_TIME",
      "group_by_fields": [
        "GROUP_BY_FIELD_WATCH_TIMESTAMP"
      ],
      "filter": {
        "start_time": "2024-07-29T15:51:28.071Z",
        "end_time": "2024-07-29T15:51:28.071Z"
      }
    }
  ]
}'

Request Collapse all

Base URL

https://api.one.blendvision.com

Auth

BearerTokenAuth

Parameters

x-bv-org-id — headerrequired

Body required

{
  "dimension_with_conditions": [
    {
      "dimension": "OVERVIEW_REPORT_DIMENSION_WATCH_TIME",
      "group_by_fields": [
        "GROUP_BY_FIELD_WATCH_TIMESTAMP"
      ],
      "filter": {
        "start_time": "2024-07-29T15:51:28.071Z",
        "end_time": "2024-07-29T15:51:28.071Z"
      }
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!