Read the attendance metric series
const url = 'https://open-api.live.gobots.com.br/v1/metrics?start_date=2026-06-01&end_date=2026-06-30&timezone=America%2FSao_Paulo&granularity=day&scopes=PRE_SALE%2FPRODUCT&metrics=total%2Cpending&dimensions=store&stores=st_0Q7pXmT2bK9wLf3ZrN1cVd&limit=50&cursor=cur_eyJlIjoxfQ.Ab3';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?start_date=2026-06-01&end_date=2026-06-30&timezone=America%2FSao_Paulo&granularity=day&scopes=PRE_SALE%2FPRODUCT&metrics=total%2Cpending&dimensions=store&stores=st_0Q7pXmT2bK9wLf3ZrN1cVd&limit=50&cursor=cur_eyJlIjoxfQ.Ab3' \ --header 'Authorization: Bearer <token>'Returns a cursor-paginated time series of the published metrics. The response echoes the
canonical query the server ran; send it back unchanged when following meta.next_cursor.
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.
Query Parameters
Seção intitulada “Query Parameters”First day of the period, inclusive.
Example
2026-06-01Last day of the period, inclusive. At most 90 days of range, never in the future.
Example
2026-06-30IANA time zone every bucket and day boundary is computed in. Defaults to UTC.
Example
America/Sao_PauloBucket size. Defaults to day.
Example
dayScopes to report. Defaults to every scope the dictionary publishes.
Example
?scopes=PRE_SALE%2FPRODUCTDictionary ids to report. Defaults to every core id. An id a selected scope does not publish is accepted and simply absent from that scope’s rows.
Example
?metrics=total,pendingBreakdown dimensions. Only store exists in v1.
Example
?dimensions=storeOpaque store ids to restrict the answer to, at most 50. An id that matches no store of this merchant answers 404. Defaults to every store of the merchant.
Example
?stores=st_0Q7pXmT2bK9wLf3ZrN1cVdRows per page, 1 to 500. Defaults to 50.
Example
50Opaque page marker from meta.next_cursor. It is bound to the exact query that issued it
and expires: changing any parameter other than limit, or waiting too long, answers 400
invalid_cursor.
Paging is consistent over a closed period; a cursor into the current day may skip or
repeat a row, because that bucket is still moving.
Example
cur_eyJlIjoxfQ.Ab3Responses
Seção intitulada “Responses”The metric series for the requested period.
object
object
object
Opaque store id, or null when the row is aggregated over stores.
Last day of the bucket, inclusive, clipped to the requested period.
Dictionary id to value. A metric that could not be measured for the bucket is absent, never zero.
object
object
Cursor of the next page, or null when the collection ends here.
Example
{ "query": { "granularity": "day", "scopes": [ "PRE_SALE/PRODUCT" ], "dimensions": [ "store" ] }, "series": [ { "scope": "PRE_SALE/PRODUCT", "marketplace": "meli" } ], "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>.
A query parameter carries a value the contract does not accept (invalid_request), the
period exceeds the maximum (period_too_long), or the cursor is expired or was not
issued for this query (invalid_cursor).
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>.
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}A requested store matches no store of this merchant.
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>.
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.