Sign in
analytics

Get Stats team(s) report

post/v1/analytics/team/stats

Request body

userIdsstring[] required

Array of encrypted user IDs to filter the report

startDatestring required

Start date for the report period in ISO 8601 format with timezone

endDatestring required

End date for the report period in ISO 8601 format with timezone

countBy'relative' | 'absolute' required

How to group the statistics (relative or absolute)

limitnumber required

Maximum number of records to return per page

pagenumber required

Page number for pagination

sortOrder'asc' | 'desc' required

Sort direction for ordering results

orderBy'prospectAdded' | 'prospectContacted' | 'opened' | 'clicked' | 'replied' | 'unSubscribed' | 'bounced' | 'Uncategorized' | 'Interested' | 'Not Interested' | 'Meeting Booked' | 'Out of Office' | 'Closed' | 'Not Now' | 'Do Not Contact' | 'prospectContacted' | 'emailSent' | 'opened' | 'clicked' | 'replied' | 'bounced' required

Field name to order the results by. Valid values depend on report type

type'prospect' | 'email' required

Type of report to generate (prospect or email)

Example request

{
  "userIds": [
    "abc123xyz",
    "def456uvw"
  ],
  "startDate": "2024-01-01T00:00:00.000+00:00",
  "endDate": "2024-01-31T23:59:59.999+00:00",
  "countBy": "absolute",
  "limit": 10,
  "page": 1,
  "sortOrder": "desc",
  "orderBy": "prospectAdded",
  "type": "prospect"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.