Transactions kpis
Description
Get the publisher transactions (Sales, Leads ...)
URL(s)
https://api.effiliation.com/api/v3/merchants/{MERCHANT_ID}/conversions/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 |
| ids | Comma separated list of String | The list id conversion ids to get (maximum 100). Required if both startDate and endDate are not provided | 123456789,99a21335883d5a783ac86a3c8109b32649a89b5325613b8a8865917e71fcff0e |
| startDate | Date: yyyy-MM-dd | Start period. Required | 2022-04-01 |
| endDate | Date: yyyy-MM-dd | End period. Required | 2022-04-03 |
| dateType | date|datetran|datevalidation | The date type to look at for specified period. Optional, default date | datetran |
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
| Field | Description | Type | |
|---|---|---|---|
| id | Id of the transaction | String | |
| commission | The commission for this transaction | Decimal | |
| kpiId | The id of the kpi (id to use in parameter kpis to restrict output) | Integer | |
| name | The name of the kpi | String | |
| value | The calculated value of the kpi | Decimal |
Examples
Get
https://api.effiliation.com/api/v3/merchants/MERCHANT_ID/conversions/kpis?api-key=YOUR_API_KEY&startDate=2002-04-01&endDate=2022-04-03&dateType=date