analytics

Get Stats team(s) report

post/v1/analytics/team/stats

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/analytics/team/stats/post.ts
A function with typed inputs. Its response is checked against the schema.

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

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 operation across all 4 revisions of this API.