Describe the published metric dictionary
const url = 'https://open-api.live.gobots.com.br/v1/metrics/dictionary';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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://open-api.live.gobots.com.br/v1/metrics/dictionary \ --header 'Authorization: Bearer <token>'Returns the versioned catalogue of scopes, metrics, granularities and dimensions this API
publishes. It makes no upstream call of its own; it answers 503 only when the merchant’s
entitlement cannot be resolved. It is in the metrics group
and therefore consumes one unit of the monthly quota: use the ETag instead of polling it.
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Header Parameters
Seção intitulada “Header Parameters”The ETag of a previously fetched representation; a match answers 304 with no body.
Responses
Seção intitulada “Responses”The published metric dictionary.
object
Semantic version of the dictionary. A new optional metric or scope bumps the minor.
Only the scopes an enabled source serves, each listing exactly the metrics that source computes for it; a core metric a scope does not list is absent from that scope’s rows.
object
object
Dictionary id. A parameterised metric is named under its parent, engaged.seller.
The root this metric parameterises, or null when it is a root itself.
object
Cursor of the next page, or null when the collection ends here.
Example
{ "granularities": [ "day" ], "dimensions": [ "store" ], "scopes": [ { "key": "PRE_SALE/PRODUCT", "metrics": [ { "kind": "core", "type": "integer", "unit": "count", "aggregation": "sum" } ] } ], "meta": { "status": "partial" }}Headers
Seção intitulada “Headers”The policies that apply to this endpoint group, as
draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.
The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.
Strong validator of the representation.
The representation is unchanged. The request still counts as one request.
Headers
Seção intitulada “Headers”Strong validator of the representation.
The policies that apply to this endpoint group, as
draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.
The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.
The API key is missing, malformed, unknown, revoked or expired.
object
Stable machine readable error code.
Human readable explanation. Never carries raw upstream text.
Seconds to wait before retrying.
Limit that was exceeded.
Remaining allowance in the current window.
Example generated
{ "code": "example", "message": "example", "retry_after": 1, "limit": 1, "remaining": 1}Headers
Seção intitulada “Headers”Bearer challenge for the API realm.
The merchant does not have the Open API add-on active.
object
Stable machine readable error code.
Human readable explanation. Never carries raw upstream text.
Seconds to wait before retrying.
Limit that was exceeded.
Remaining allowance in the current window.
Example generated
{ "code": "example", "message": "example", "retry_after": 1, "limit": 1, "remaining": 1}The requests-per-minute limit of the endpoint group was exceeded (rate_limited), or the
monthly request quota of the merchant is exhausted (quota_exceeded).
object
Stable machine readable error code.
Human readable explanation. Never carries raw upstream text.
Seconds to wait before retrying.
Limit that was exceeded.
Remaining allowance in the current window.
Example generated
{ "code": "example", "message": "example", "retry_after": 1, "limit": 1, "remaining": 1}Headers
Seção intitulada “Headers”The policies that apply to this endpoint group, as
draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.
The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.
Seconds to wait before retrying, per RFC 9110.
The upstream source is unavailable. When the merchant’s entitlement could not be resolved the request is refused before rate limiting, so the RateLimit headers are absent.
object
Stable machine readable error code.
Human readable explanation. Never carries raw upstream text.
Seconds to wait before retrying.
Limit that was exceeded.
Remaining allowance in the current window.
Example generated
{ "code": "example", "message": "example", "retry_after": 1, "limit": 1, "remaining": 1}Headers
Seção intitulada “Headers”As the RateLimit-Policy response header; absent when entitlement could not be resolved.
As the RateLimit response header; absent when entitlement could not be resolved.