Skip to main content
GET
/
api
/
v1
/
accounts
/
{accountId}
/
invitations
/
stats
Get Invitation Stats
curl --request GET \
  --url https://api.example.com/api/v1/accounts/{accountId}/invitations/stats
{
  "groups": {},
  "labels": {},
  "aggregations": {}
}

Path Parameters

​
accountId
string
required

The ID of the account

Query Parameters

​
start
string

Start date for the aggregation

Example:

"2023-01-01T00:00:00Z"

​
end
string

End date for the aggregation

Example:

"2023-01-31T23:59:59Z"

​
statType
enum<string>

Filter by stat type

Available options:
invitation_click,
invitation_accepted,
ocr,
invitation_accepted_rate,
invitation_created
​
statInterval
enum<string>

Interval for the aggregation

Available options:
1 day,
1 week,
1 month,
1 year
​
maxBuckets
string

Maximum number of buckets

Example:

"30"

​
widgetConfigurationId
string

Filter by widget configuration ID

​
deploymentId
string

Filter by deployment ID

​
widgetId
string

Filter by widget ID

​
facet
enum<string>

Facet for the aggregation

Available options:
widget,
environment,
deployment,
widgetConfiguration,
source
​
environmentRole
enum<string>

Filter by environment role

Available options:
production,
development
​
environmentId
string

Filter by environment ID

​
groupType
string

Filter by group type (deprecated: use scopeType instead)

​
scopeType
string

Filter by scope type

Response

​
groups
object
required

A map of group types to their respective aggregation results

​
labels
object
required

A map of label names to their respective display names

​
aggregations
object
required

An optional set of meta data when relevant to the query type