Programs (v1.0)
S
Written by Sascha Hoffmann
Updated over a week ago

Simple but powerful REST API to get all available programs at advanced store.

Old Version of the API:

  • API 2023-04 (supported until the end of February 2024)

Authorization

For your authorization, you need a token. In order to receive a token please read advanced API - Get an access token.

Filter

To narrow your results or include and exclude specific information, there are different request parameters available. Simply attach these parameters to the URL of your GET request.

Domain

https://api.advanced-store.com/publishers/programs/1.0/

GET parameters reference

Name

Description

siteId

Add your siteId

integer, mandatory

subId

Add an internal identifier to track different campaigns or placements.

page

Page number for the pagination

integer, mandatory

size

Set the page size

integer, mandatory

sortBy

Sort the results by name or last updated timestamp.

string, optional
(lastUpdated, name)

sortOrder

Sorts the records in ascending or descending order. Default is ASC.

ASC or DESC

search

Filter results by search string. E.x. advertiser name.

string, optional

categories

Filter results by category.

string, optional

countries

Filter results by country. For example, DE or US.

2-letter-code, optional

logos

Extend the response by a URL of a logo

integer, optional
(1 or 0)

url

Filter results by domain. E.g. example.com

string, optional

maxSubIdLength

Filter results by length of subid support

integer, optional

headers

Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Example request

curl --location 'https://api.advanced-store.com/publishers/programs/1.0/?page=1&size=1&siteId=100&maxSubIdLength=256&countries=DE&categories=Fashion&logos=1&subId=bla&sortBy=name&sortOrder=DESC' \
--header 'Authorization: Bearer ory_at_ImP4...' \
--header 'Content-Type: application/json'

Results

As a response you'll get a JSON structure for all matching programs of your request.

Example response

{
"totalEntries": 1,
"currentPage": 1,
"totalPageCount": 1,
"pageSize": 10,
"programDataList": [{
"id": 455,
"externalNetworkId": "23875",
"name": "Saninforma",
"lastUpdated": 1704183773144,
"url": "saninforma.it",
"matchingUrls": [],
"categories": [
"Health & Care"
],
"countries": [{
"countryCode": "IT",
"name": "Italy"
}],
"averageCommission": 2.36,
"clickLink": "https://as.ad4m.at/ad/tur?a=1267&b=Test&c=https://saninforma.it",
"activeAds": {
"Text": 1,
"advanced API": 1,
"Display": 11
},
"maxSubIdLength": 200,
"network": "Tradetracker",
"acpm": 0.46
}]
}

Response reference

Name

Description

averageCommission

Average commission in EUR of all transactions of this program.

maxSubIdLength

Maximal support of chars by this network. Sub-Ids longer then that will be truncated.

countries

Array of all countries where this program can be advertised. The array includes an object with country code as well as country name.

lastUpdated

Timestamp

url

The main domain name of that program.

matchingUrls

More specific url for that program. Mainly used to distinguish between single programs of the same advertiser. E.g. for different countries or business areas.

activeAds

Shows which kind of ad type we have on our database.

clickLink

The trackinglink for that program. Use this to earn money.

๐Ÿ’ก The generated trackinglink is using our Redirect API. If you don't need the information included in the result described below, you also can much easier create the trackinglinks yourself without a REST GET request.

Did this answer your question?