Program remunerations
Description
Get the publisher program remuneration details
URL(s)
https://api.effiliation.com/api/v3/merchants/programs/remunerations?api-key=YOUR_API_KEY
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 |
| programId | Integer | Program id. Required if both merchantId and sessionId are not provided | 123456789 |
| merchantId | Integer | Merchant id. Required if both programId and sessionId are not provided | 123456789 |
| sessionId | Integer | Session id. Required if both programId and merchantId are not provided | 123456789 |
Returned fields
| Field | Description | Type | |
|---|---|---|---|
| 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 | |
| baseRemuneration | The base remuneration of the program | Decimal | |
| hdr | The hdr | Decimal | |
| remuneration | The total remuneration amount (including hdr) | Decimal | |
| type | The type of the remuneration : percent or fixed | String |
Examples
Get current remuneration for the subscribed program or merchant MERCHANT_ID as json
https://apiv2.effiliation.com/apiv2/programs.xml?api-key=YOUR_API_KEY&format=json&merchantId=MERCHANT_ID