GET api/v1/forms/registrations/stats

List form registration stats

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Filter

Filter records

ListFormRegistrationStatsV1Filter

None.

Select

Select columns

Collection of ListFormRegistrationStatsV1Select

Default value: All

Example value: RegistrationCount, HighestSerialNumber

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

Collection of ListFormRegistrationStatsV1Sort

Default value: RegistrationCount

Example value: RegistrationCount

Max items: 3

Unique items

PageNumber

Page number

integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647

PageSize

Number of records per page

integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of form registration stats

ListFormRegistrationStatsV1Response
NameDescriptionTypeAdditional information
FormRegistrationStats

List of form registration stats

Collection of ListFormRegistrationStatsV1ResultFormRegistrationStats

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "FormRegistrationStats": [
    {
      "FormId": "ecc808a2-b356-49d7-8d09-c03b40a5ae7d",
      "RegistrationCount": 42,
      "HighestSerialNumber": 42,
      "BusinessGroupId": "8443235c-a450-42a2-8f99-2eb1c6341778",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "FormId": "ecc808a2-b356-49d7-8d09-c03b40a5ae7d",
      "RegistrationCount": 42,
      "HighestSerialNumber": 42,
      "BusinessGroupId": "8443235c-a450-42a2-8f99-2eb1c6341778",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}