Incentives Kpi
Get All
Get all the incentive-kpis.
get/public/api/incentives-kpi?filter={filter}
Request
- Base URLhttps://<base_url>
- AuthHTTP bearer
Query parameters
filterstring
A valid JSON filter object
Headers
Acceptstring
e.g. application/json
Request body
Example request
{
"Authorization": {
"Authorization": "Bearer JWT"
}
}Response
OK
Example response
{
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 10,
"count": 5,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:35:00.000Z"
},
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb096",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"participant_id": "api_team",
"product_id": "5eb8fd017d5ff5748adcaef5",
"product_name": "myproduct",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 20,
"count": 2,
"weight": 2,
"price": 5,
"participant_type": "teams",
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
}
]
}Changes
No recorded changes to this operation across all 28 revisions of this API.