GET
/
v3
/
orgs
/
{orgId}
/
data-capture
/
forms
/
stats
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/forms/stats \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "stats",
      "attributes": {
        "granularity": "day",
        "time": "2024-06-28T08:50",
        "value": 245
      },
      "meta": {
        "time": {
          "since": {
            "formatted": {
              "rfc3339": "2024-06-28T08:50:00Z"
            },
            "parts": {
              "year": 2024,
              "month": 6,
              "day": 28,
              "hour": 8,
              "minute": 50
            }
          },
          "until": {
            "formatted": {
              "rfc3339": "2024-06-28T08:51:00Z"
            },
            "parts": {
              "year": 2024,
              "month": 6,
              "day": 28,
              "hour": 8,
              "minute": 51
            }
          }
        }
      }
    }
  ],
  "meta": {
    "headlines": {
      "slices": {
        "granularity": "day",
        "count": 14
      },
      "avg": {
        "value": 17.5
      },
      "sum": {
        "value": 245
      }
    }
  }
}
This endpoint returns submission counts for this form within the time bound range that you specify in the filter. Calling this endpoint means you must send both the filter[created_at.since] and filter[created_at.until] parameters.
You can choose a granularity for the response data. Make sure that you pick one that is appropriate to the time bounds you request. It is likely that in the future, we will prevent too many buckets being returned based on the bounds.For example, if you are retrieving stats from 1st June to the 30th June, daily is a good granularity.

Authorizations

​
Authorization
string
header
required

To understand how to authenticate, see the auth docs

Path Parameters

​
orgId
string
required

The ID of the organisation

Example:

"cc9746e0-9286-4575-ae0b-ac1b0fe873a6"

Query Parameters

​
filter[created_at.since]
string
required

The start time for the filter (in RFC 3339 format)

Example:

"2014-05-01T00:00:00Z"

​
filter[created_at.until]
string
required

The end time for the filter (in RFC 3339 format)

Example:

"2014-07-01T00:00:00Z"

​
filter[created_at.granularity]
enum<string>

The granularity of the time buckets that we place the number of submissions into

Available options:
year,
month,
day,
hour,
minute
Example:

"day"

​
filter[author.id]
string<uuid>

The author of the submissions to return

Example:

"f078b255-7ff4-4425-8322-8e57e4aa772d"

Response

200 - application/json

The response is of type object.