Skip to main content
GET
/
data
/
reports
/
snapshots
Snapshots de negocio
curl --request GET \
  --url https://api.service.getjusto.com/v3/data/reports/snapshots \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "items": [
      {
        "_id": "<string>",
        "websiteId": "<string>",
        "storeId": "<string>",
        "countryCode": "<string>",
        "timeframe": "<string>",
        "fromDate": "2023-11-07T05:31:56Z",
        "toDate": "2023-11-07T05:31:56Z",
        "data": {
          "storesCount": 123,
          "storesWithOrders": 123,
          "ecommerceTotalOrderValue": 123,
          "ecommerceOrdersCount": 123,
          "ecommerceAverageOrderValue": 123,
          "justoDeliveryOrdersShare": 123,
          "pdvOrdersCount": 123,
          "pdvTotalOrderValue": 123,
          "pdvOrderBySource": {}
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 123,
    "limit": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getjusto.com/llms.txt

Use this file to discover all available pages before exploring further.

Este reporte entrega snapshots diarios, semanales o mensuales de métricas de negocio ya precalculadas para la marca autorizada. Es la fuente más eficiente para consultar métricas históricas. Úsala siempre que sus campos y filtros respondan la pregunta antes de pedir reportes más pesados.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

scope
enum<string>
required

Usa website para snapshots agregados de marca o store para snapshots por local.

Available options:
website,
store
timeframeType
enum<string>
required

Granularidad precalculada del snapshot.

Available options:
day,
week,
month
timeframe
string

Periodo exacto a buscar. Formatos: YYYY-MM-DD para day, YYYY-W## para week, YYYY-MM para month.

fromDate
string<date-time>
Example:

"2020-01-01T00:00:00.000Z"

toDate
string<date-time>
Example:

"2020-01-01T00:00:00.000Z"

storeIds
string[]

IDs de locales. Solo aplica cuando scope=store.

countryCode
string

Código de país ISO 3166-1 alpha-2

Example:

"CL"

page
number

Página a retornar. Por defecto: 1.

limit
number

Cantidad de snapshots por página. Por defecto: 100. Máximo: 500.

Response

The OpenAPI spec

success
boolean
Example:

true

data
object