Programs
Description
Get the publisher programs
URL(s)
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY https://apiv2.effiliation.com/apiv2/programs.csv?key=YOUR_API_KEY https://apiv2.effiliation.com/apiv2/programs.json?key=YOUR_API_KEY
Parameters
| Parameter | Format | Description | Example value |
|---|---|---|---|
| key | String | Publisher api key | YOUR_API_KEY |
| filter | String | Allows to filter the program list on properties such as publisher activity, registration state, publisher programs, effiliation recommandations... | mines(programs I am registered), recommendation(programs I am not registered), active(programs I am active on), inactive(programs I am not active on), pending(programs on which my registration is pending), unregistered(programs I have been unregistered), closed(closed programs I am registered), refused(programs on which my registration has been refused), all(all programs) |
| lg | String | Output language | fr, en, es, it, pt, de, nl |
| mode | String | Allows to filter the program list on new programs, exclusive programs or programs with ongoing challenge | new, challenge, exclu |
| com | String | Allows to filter the program list on commission type, several values separated by commas can be set | cpa, cpl, cpc, cpm, postclic, postview |
| country | String | Allows to filter the program list on coverage countries, several values separated by commas can be set | fr, ge, au, be, da, sp, gr, nl, it, uk, sw, sz, br, bu, cy, en, fi, hu, ei, lg, lh, lu, mt, pl, pt, ro, lo, si, cz, tu |
| categories | String | Allows to filter the program list on advertiser categories id, several values separated by commas can be set | A category ID is an integer value. Check our category API documentation |
| score | String | Allows to filter the program list on advertiser score (based on advertiser delays in payment), several values separated by commas can be set | a, b, c, d, e |
Returned fields
Use fields selector to choose the fields you need. Eg: fields=00101.
| Field | Description | Type | |
|---|---|---|---|
| id_affilieur | Advertiser unique id for Effiliation | Integer | |
| id_programme | Campaign unique ID | Integer | |
| date_debut | Creation date of the campaign | Date | |
| date_fin | End date of the campaign | Date | |
| description | Campaign description | String | |
| siteannonceur | Advertiser site name | String | |
| urlannonceur | Advertiser url | String | |
| id_session | Campaign registration ID | Integer | |
| url_inscription | Direct URL for registration | String | |
| inscription | Campaign registration date | String | |
| categories | Advertiser categories | String | |
| responsable | Effiliation account manager | String | |
| tm | Effiliation traffic manager | String | |
| etat | Publisher registration state. Empty value : publisher is not registered Joined / Inscrit / Eingeschrieben / Inscrito / Iscritto / Ingeschreven : publisher is registered De-registered / Désinscrit / Abgemeldet / Dado de baja / Iscrizione cancellata / Uitgeschreven / Anulado : publisher is no more registered Pending / En attente / Ausstehend / En espera / In attesa / In behandeling / Em espera : pending registration Refused / Refusé / Abgelehnt / Rechazado / Rifiutato / Geweigerd / Recusado : refused registration | String | |
| url | Program url | String | |
| urllo | Program logo url | String | |
| url_tracke | Tracked URL for the default link of the advertiser | String | |
| nom | Program name | String | |
| typecom | Commission type | String | |
| pays | Campaign coverage countries | String | |
| dureecookies | Post-clic cookies duration in days | Integer | |
| dureecookiespi | Post-view cookies duration in days | Integer | |
| scoredb | Advertiser score based on his delays in payment | String | |
| remuneration | Remuneration description | String | |
| affichage | Impression | Decimal | |
| clic | Unique click | Decimal | |
| cpctot | Total CPC | Decimal | |
| doubleclic | Double click | Decimal | |
| ventefixe | Sale's fix amount | Decimal | |
| ventefixe2 | Special indicator A2 | Decimal | |
| ventefixe3 | Special indicator A3 | Decimal | |
| ventefixe4 | Special indicator A4 | Decimal | |
| ventefixe5 | Special indicator A5 | Decimal | |
| ventefixepi | Post-view sale's fix amount | Decimal | |
| ventefixe2pi | Special indicator C2 | Decimal | |
| ventefixe3pi | Special indicator C3 | Decimal | |
| ventefixe4pi | Special indicator C4 | Decimal | |
| ventefixe5pi | Special indicator C5 | Decimal | |
| revenue | Turn over percentage | Decimal | |
| revenue2 | Special indicator A2 | Decimal | |
| revenue3 | Special indicator A3 | Decimal | |
| revenue4 | Special indicator A4 | Decimal | |
| revenue5 | Special indicator A5 | Decimal | |
| revenuepi | Post-view turn over percentage | Decimal | |
| revenuepi2 | Special indicator C2 | Decimal | |
| revenuepi3 | Special indicator C3 | Decimal | |
| revenuepi4 | Special indicator C4 | Decimal | |
| revenuepi5 | Special indicator C5 | Decimal | |
| lead | Lead | Decimal | |
| lead2 | Special indicator B2 | Decimal | |
| lead3 | Special indicator B3 | Decimal | |
| lead4 | Special indicator B4 | Decimal | |
| lead5 | Special indicator B5 | Decimal | |
| leadpi | Post-view lead | Decimal | |
| leadpi2 | Special indicator D2 | Decimal | |
| leadpi3 | Special indicator D3 | Decimal | |
| leadpi4 | Special indicator D4 | Decimal | |
| leadpi5 | Special indicator D5 | Decimal | |
| emailingdedie | Emailing leverage | String | |
| nblien | Number of links | Integer | |
| nouveau | Indicates whether the program is new | String | |
| exclusivite | Indicates whether the advertiser is an Effiliation exclusive client | String | |
| nom_challenge | Challenge name | String | |
| deb_challenge | Challenge start | Date | |
| fin_challenge | Challenge end | Date | |
| desc_challenge | Challenge description | String | |
| tauxclic | Click rate | String | |
| transformation | Transformation rate | String | |
| tauxannul | Annulation rate | String | |
| epc | EPC | String | |
| ecpm | ECPM | String | |
| activite | Campaign publisher activity flag | String | |
| evenements | Events linked to the program advertiser | String | |
| mobile | Mobile site or mobile optimized site | String | |
| shop | Physical Store | String | |
| applimobile | Mobile application | String | |
| ventefixe6 | Special indicator A6 | Decimal | |
| ventefixe7 | Special indicator A7 | Decimal | |
| ventefixe8 | Special indicator A8 | Decimal | |
| ventefixe9 | Special indicator A9 | Decimal | |
| ventefixe10 | Special indicator A10 | Decimal | |
| ventefixe11 | Special indicator A11 | Decimal | |
| ventefixe12 | Special indicator A12 | Decimal | |
| ventefixe13 | Special indicator A13 | Decimal | |
| ventefixe14 | Special indicator A14 | Decimal | |
| ventefixe15 | Special indicator A15 | Decimal | |
| ventefixe16 | Special indicator A16 | Decimal | |
| ventefixe17 | Special indicator A17 | Decimal | |
| ventefixe18 | Special indicator A18 | Decimal | |
| ventefixe19 | Special indicator A19 | Decimal | |
| ventefixe20 | Special indicator A20 | Decimal | |
| ventefixe6pi | Special indicator A6 | Decimal | |
| ventefixe7pi | Special indicator A7 | Decimal | |
| ventefixe8pi | Special indicator A8 | Decimal | |
| ventefixe9pi | Special indicator A9 | Decimal | |
| ventefixe10pi | Special indicator A10 | Decimal | |
| ventefixe11pi | Special indicator A11 | Decimal | |
| ventefixe12pi | Special indicator A12 | Decimal | |
| ventefixe13pi | Special indicator A13 | Decimal | |
| ventefixe14pi | Special indicator A14 | Decimal | |
| ventefixe15pi | Special indicator A15 | Decimal | |
| ventefixe16pi | Special indicator A16 | Decimal | |
| ventefixe17pi | Special indicator A17 | Decimal | |
| ventefixe18pi | Special indicator A18 | Decimal | |
| ventefixe19pi | Special indicator A19 | Decimal | |
| ventefixe20pi | Special indicator A20 | Decimal | |
| revenue6 | Special indicator A6 | Decimal | |
| revenue7 | Special indicator A7 | Decimal | |
| revenue8 | Special indicator A8 | Decimal | |
| revenue9 | Special indicator A9 | Decimal | |
| revenue10 | Special indicator A10 | Decimal | |
| revenue11 | Special indicator A11 | Decimal | |
| revenue12 | Special indicator A12 | Decimal | |
| revenue13 | Special indicator A13 | Decimal | |
| revenue14 | Special indicator A14 | Decimal | |
| revenue15 | Special indicator A15 | Decimal | |
| revenue16 | Special indicator A16 | Decimal | |
| revenue17 | Special indicator A17 | Decimal | |
| revenue18 | Special indicator A18 | Decimal | |
| revenue19 | Special indicator A19 | Decimal | |
| revenue20 | Special indicator A20 | Decimal | |
| revenuepi6 | Special indicator A6 | Decimal | |
| revenuepi7 | Special indicator A7 | Decimal | |
| revenuepi8 | Special indicator A8 | Decimal | |
| revenuepi9 | Special indicator A9 | Decimal | |
| revenuepi10 | Special indicator A10 | Decimal | |
| revenuepi11 | Special indicator A11 | Decimal | |
| revenuepi12 | Special indicator A12 | Decimal | |
| revenuepi13 | Special indicator A13 | Decimal | |
| revenuepi14 | Special indicator A14 | Decimal | |
| revenuepi15 | Special indicator A15 | Decimal | |
| revenuepi16 | Special indicator A16 | Decimal | |
| revenuepi17 | Special indicator A17 | Decimal | |
| revenuepi18 | Special indicator A18 | Decimal | |
| revenuepi19 | Special indicator A19 | Decimal | |
| revenuepi20 | Special indicator A20 | Decimal | |
| lead6 | Special indicator A6 | Decimal | |
| lead7 | Special indicator A7 | Decimal | |
| lead8 | Special indicator A8 | Decimal | |
| lead9 | Special indicator A9 | Decimal | |
| lead10 | Special indicator A10 | Decimal | |
| lead11 | Special indicator A11 | Decimal | |
| lead12 | Special indicator A12 | Decimal | |
| lead13 | Special indicator A13 | Decimal | |
| lead14 | Special indicator A14 | Decimal | |
| lead15 | Special indicator A15 | Decimal | |
| lead16 | Special indicator A16 | Decimal | |
| lead17 | Special indicator A17 | Decimal | |
| lead18 | Special indicator A18 | Decimal | |
| lead19 | Special indicator A19 | Decimal | |
| lead20 | Special indicator A20 | Decimal | |
| leadpi6 | Special indicator A6 | Decimal | |
| leadpi7 | Special indicator A7 | Decimal | |
| leadpi8 | Special indicator A8 | Decimal | |
| leadpi9 | Special indicator A9 | Decimal | |
| leadpi10 | Special indicator A10 | Decimal | |
| leadpi11 | Special indicator A11 | Decimal | |
| leadpi12 | Special indicator A12 | Decimal | |
| leadpi13 | Special indicator A13 | Decimal | |
| leadpi14 | Special indicator A14 | Decimal | |
| leadpi15 | Special indicator A15 | Decimal | |
| leadpi16 | Special indicator A16 | Decimal | |
| leadpi17 | Special indicator A17 | Decimal | |
| leadpi18 | Special indicator A18 | Decimal | |
| leadpi19 | Special indicator A19 | Decimal | |
| leadpi20 | Special indicator A20 | Decimal | |
| authorized_typologies | Authorized typologies | String |
Examples
An XML feed with all my programs
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY&filter=mines
An XML feed with all my programs, with b2b categories Administrative / Management or Associations / Communities
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY&filter=mines&b2b=23,24
An XML feed with all my programs, with b2c categories Alcohol & Food or Animals
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY&filter=mines&b2c=19,21
An XML feed with all programs I'm active on
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY&filter=active
An XML feed with all programs I'm not active on
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY&filter=inactive
A CSV feed with all programs I'm not registered
https://apiv2.effiliation.com/apiv2/programs.csv?key=YOUR_API_KEY&filter=recommendation
An XML feed with all my programs, on which there is an ongoing challenge
https://apiv2.effiliation.com/apiv2/programs.xml?key=YOUR_API_KEY&filter=mines&mode=challenge
A CSV feed with all new programs I'm not registered yet, in english
https://apiv2.effiliation.com/apiv2/programs.csv?key=YOUR_API_KEY&filter=recommendation&mode=new&lg=en
A JSON feed with all programs on which I have a pending registration, with only french and german programs
https://apiv2.effiliation.com/apiv2/programs.json?key=YOUR_API_KEY&filter=pending&country=fr,ge