Record data
Record Data Views return a single row of data per grouping with all other fields aggregated. This data shape returns record level detail.
Sales data example
An example of a request to a DataView, configured for a records data shape, with the following configuration:
Name | Grouped | Aggregation |
---|---|---|
saleAmount | - | - |
saleType | - | - |
Given this configuration, a request to the view may return data similar to the following:
{
before: 8819191999110,
after: 199191999191,
"data": [
{
"saleAmount": 123,
"saleType": "online"
},
{
"saleAmount": 1231,
"saleType": "in-store"
},
{
"saleAmount": 1231,
"saleType": "in-store"
},
...
]
}
Cursor pagination
Record data is paged via cursor pagination. Each request presents a before
and after
value, alongside the record data. These values can be passed within the request to control record pagination.
Retrieving the next page of records
To return the next set of data include the after
cursor in the request. This should be the after
value received with the previous request.
{
"after": 123123123
}
Retrieving the previous page of records
To return the previous set of data include the before
cursor in the request. This should be the before
value received with the previous request.
{
"before": 991218818
}
Limiting record count
By default, up to 100 records are returned per request. This value can be lowered by passing the limit
value within the request.
{
"limit": 10
}