Get program information details for publisher.
  • 08 Jul 2024
  • Dark
    Light

Get program information details for publisher.

  • Dark
    Light

Article summary

Get
/publishers/{publisherId}/programmedetails

GET programmedetails

Publishers get a set of KPIs of the programmes they are working with, along with the programme description and range of commission (across commission groups) they get in the programmes.

Who can use it

Publishers 

Header parameters
Authorization
string

accessToken

Path parameters
publisherId
integer (int64) Required

publisherId

Query parameters
accessToken
stringRequired

access token

advertiserId
integer (int64) Required

advertiserId

relationship
string

relationship

Valid values[ "\"joined\"", "\"pending\"", "\"suspended\"", "\"rejected\"", "\"notjoined\"", "\"any\"" ]
Default"joined"
Responses
200

OK

Expand All
object
commissionRange
Array of object (CommissionGroupRange)
object
max
number (double)
min
number (double)
type
string
kpi
object (Kpi)
approvalPercentage
number (double)
averagePaymentTime
string
awinIndex
number (double)
conversionRate
number (double)
epc
number (double)
validationDays
integer (int32)
programmeInfo
object (ProgrammeDetailsInfo)
clickThroughUrl
string
currencyCode
string
deeplinkEnabled
boolean
description
string
displayUrl
string
id
integer (int64)
logoUrl
string
membershipStatus
string
name
string
primaryRegion
object (PrimaryRegion)
countryCode
string
name
string
primarySector
string
validDomains
Array of object (Domain)
object
domain
string

Which data fields do we provide

programmeInfo object:

field namedescription
idID of the programme
namename of the programme
displayUrlURL of the advertiser
clickThroughUrladvertiser programme click-through URL
deeplinkEnabledboolean value indicating if the advertiser has deeplink enabled
descriptionprogramme description
membershipStatusmembership status between publisher and advertiser programme. Can be Joined, Pending, Suspended, Rejected and Notjoined
logoUrlURL to the logo of the programme
primaryRegionobject that contains the name and the countryCode of the primary programme region
validDomainsan object that contains domains from which the advertiser accepts transaction
currencyCodeISO code of the currency of the programme

kpi object:

field namedescription
averagePaymentTimepublisher
approvalPercentagethe approval percentage relates to the proportion of pending transactions which are then validated as approved
epcearnings per click
conversionRatethe conversion rate is the total number of sales divided by the total number of clicks
validationDaysthe validation period represents the average amount of time an advertiser takes to validate pending transactions as either Approved or Declined
awinIndexa score out of hundred, calculated from an algorithm of EPC, approval percentage, conversion rate and validation period

commissionRange object:

field namedescription
minminimal commission across commission groups, either in percent or amount
maxmaximum commission across commission groups, either in percent or amount
typepercentage or amount; for amount the value is in the currency of the programme (see programmeInfo object) 

Was this article helpful?