Get the report schema
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/reports/schema';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://apibase.ecomweb.app/api/v1/stores/example/reports/schema \ --header 'x-api-key: <x-api-key>'Lists every dataset a report can read, with the measures, dimensions and filters each one offers. Use it to build a valid report definition for the run and save routes. For a filter whose values belong to the store, such as sales channels, the allowed values and their display names are included.
Required scopes: read:analytics
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
The datasets a report can read.
object
Measures the dataset offers.
object
Measure type.
Measure key, used in measures.
Translation key of the label.
Dimension keys that make this measure meaningless, such as grouping a count by the thing it counts. Advice only; the report still runs.
Dimensions the dataset offers.
object
Dimension type.
Time grains a date dimension accepts.
Dimension key, used in dimensions.
Translation key of the label.
Filters the dataset offers.
object
Display names for values that are ids, keyed by value.
object
Filter key, used as field in filters.
Operators the filter accepts.
The values the filter accepts, when it has a fixed list or a list defined by the store.
Dataset key, used as dataset.
Translation key of the label.
False when date_range does not limit this dataset.
Example
{ "datasets": [ { "measures": [ { "type": "money" } ], "dimensions": [ { "type": "string", "grains": [ "day" ] } ] } ]}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}