No results

Fetch list stats

Calculate usage metrics for a list.

GET https://api.jsonpad.io/lists/{listId}/stats

Example

cURL
123curl https://api.jsonpad.io/lists/4c0852fd-728d-4675-a584-41ba56d7c66f/stats \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    daysnumberhttps://api.jsonpad.io/lists/081e8a17-65e7-4e72-9be1-6a6f94374ae9/stats?days=7The number of days to collect stats for. The default value is 7 and the maximum is 90.

Request headers

  • required
    x-api-tokenstringYour API token.

Request body

No request body

Response body

200 OK
{
maxItems: null
maxIndexes: null
items: {
total: 9
totalThisPeriod: 7
metrics: [
0: {
date: "2026-09-03T11:29:45.229Z"
count: 4
lists: {
3b41c0c7-51e5-404e-83d2-d73825321f85: 4
}
}
1: {
date: "2026-09-04T11:29:45.229Z"
count: 1
lists: {
3b41c0c7-51e5-404e-83d2-d73825321f85: 1
}
}
2: {
date: "2026-09-05T11:29:45.229Z"
count: 2
lists: {
3b41c0c7-51e5-404e-83d2-d73825321f85: 2
}
}
]
}
indexes: {
total: 3
totalThisPeriod: 1
metrics: [
0: {
date: "2026-09-03T11:29:45.229Z"
count: 1
lists: {
3b41c0c7-51e5-404e-83d2-d73825321f85: 1
}
}
1: {
date: "2026-09-04T11:29:45.229Z"
count: 0
lists: {
}
}
2: {
date: "2026-09-05T11:29:45.229Z"
count: 0
lists: {
}
}
]
}
events: {
total: 4
totalThisPeriod: 4
metrics: [
0: {
date: "2026-09-03T11:29:45.229Z"
count: 3
types: {
list-created: 2
list-updated: 1
}
}
1: {
date: "2026-09-04T11:29:45.229Z"
count: 1
types: {
list-updated: 1
}
}
2: {
date: "2026-09-05T11:29:45.229Z"
count: 0
types: {
}
}
]
}
}
  • maxItemsnullable numberThe maximum number of items allowed in this list, based on your current subscription limits.
  • maxIndexesnullable numberThe maximum number of indexes allowed in this list, based on your current subscription limits.
  • itemsobjectItem metrics for this list.
    Items attributes
    • totalnumberThe total number of items in this list.
    • totalThisPeriodnumberThe total number of items created in this list during the requested period.
    • metricsarrayA list of metrics objects for each day in the requested period.
    • metrics[].datestringThe date of this metrics entry in ISO 8601 format.
    • metrics[].countnumberThe total number of items created on this date.
    • metrics[].listsobject

      The total number of items created on this date, broken down by list id.

      For this endpoint, because we're requesting stats for a single list, this object will have at most one key, and the value should match metrics[].count.

  • indexesobjectIndex metrics for this list.
    Indexes attributes
    • totalnumberThe total number of indexes in this list.
    • totalThisPeriodnumberThe total number of indexes created in this list during the requested period.
    • metricsarrayA list of metrics objects for each day in the requested period.
    • metrics[].datestringThe date of this metrics entry in ISO 8601 format.
    • metrics[].countnumberThe total number of indexes created on this date.
    • metrics[].listsobject

      The total number of indexes created on this date, broken down by list id.

      For this endpoint, because we're requesting stats for a single list, this object will have at most one key, and the value should match metrics[].count.

  • eventsobjectEvent metrics for this list.
    Events attributes
    • totalnumberThe total number of events for this list.
    • totalThisPeriodnumberThe total number of events for this list during the requested period.
    • metricsarrayA list of metrics objects for each day in the requested period.
    • metrics[].datestringThe date of this metrics entry in ISO 8601 format.
    • metrics[].countnumberThe total number of events on this date.
    • metrics[].typesobject

      The total number of events on this date, broken down by type.

Response headers

No response headers

2024-10-29