Reporting kpis
Description
Provides a reporting for merchant kpis on a given period
URL(s)
https://api.effiliation.com/api/v3/merchants/{MERCHANT_ID}/reporting/kpis?api-key=YOUR_API_KEY
Url Parameters
| Parameter | Format | Description | Example value |
|---|---|---|---|
| MERCHANT_ID | Integer | Merchant id. Required | 123456789 |
Parameters
| Parameter | Format | Description | Example value |
|---|---|---|---|
| api-key | String | Publisher api key | YOUR_API_KEY |
| format | Accepted values : csv|xml|json | The output format to use. Required | csv |
| kpis | Comma separated list of Integer | The list of kpis to display. Optional, default all kpis | 123456789,987654321 |
| dateType | date|datetran|datevalidation | The date type to look at for specified period. Optional, default date | datetran |
| startDate | Date: yyyy-MM-dd | Start period. Required if ids is not provided or if endDate is provided. | 2022-04-01 |
| endDate | Date: yyyy-MM-dd | End period. Required if ids is not provided or if startDate is provided | 2022-04-03 |
TooManyRequest
Only on request every 15 minutes is allowed. If you run an other request within this delai you'll get a 429 http code.
The message tells you when you can run your query agin.
Returned fields
Use fields selector to choose the fields you need. Eg: fields=00101.
| Field | Description | Type | |
|---|---|---|---|
| day | The day of the reporting | String : Total or Date format : yyyy-MM-dd | |
| merchantId | The merchant id | Integer | |
| programId | The program id | Integer | |
| sessionId | The session id | Integer | |
| id | The id of the kpi (id to use in parameter kpis to restrict output) | Integer | |
| name | The name of the kpi | String | |
| value | The value of the kpi | Decimal |
Examples
Reporting by transaction date between 01/04/2022 and 30/04/2022 for merchant "merchantId"
https://api.effiliation.com/api/v3/merchants/MERCHANT_ID/reporting/kpis?api-key=YOUR_API_KEY&dateType=datetran&startDate=01/04/2022&end=30/04/2022