/v1/employees/{affiliateEmployeeId}/metrics

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint returns an employee's participation related data for giving and volunteering.

The start and end params control the date range for the metrics summary. Pass standard date format (mm/dd/yy). Data is available for records created after 2014.

The dateType param should be defined as "donated" or "created" and applies only to donation metrics. This controls which donations are included in the metrics summary by the date the record was created or the date of the actual donation. For example a user can record an offline donation on 01/01/19 but the donation date of that offline donation was 12/15/18. The created date is 01/01/19 and the donation date was 12/15/18. For a company match or incentive request that requires approval, the date the employee submits the request will be the create date and the date the request is approved and becomes a donation is the donation date.



Path Params
int32
required
Query Params
int32
enum
Allowed:
date-time
date-time
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request

404

Not Found

500

Server Error

Language
LoadingLoading…
Response
Choose an example:
text/plain
application/json
text/json