Legacy: List of programs (2023-04)
Heiko Vogelgesang avatar
Written by Heiko Vogelgesang
Updated over a week ago

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

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.

๐Ÿ’ก 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.

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

country

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

minSubIdLength

Filter results by length of subid support

integer, optional

Example request

curl --request GET 'https://advanced-store.cloud/function/api/2023-04/programs?siteId=1267&subId=TEST&page=1&logos=1&sortBy=lastUpdated&size=10'

Results

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

Example response

{
"data": {
"totalEntries": 1,
"currentPage": 1,
"totalPageCount": 1,
"pageSize": 1,
"data": [
{
"id": "20774",
"externalNetworkId": "1226",
"name": "o2-Partnerprogramm",
"lastUpdated": "1648555923153",
"aCPM": 0.10983081991479728,
"url": "o2online.de",
"matching_urls": [
"https://music.o2online.de",
"https://www.o2online.de/campaigns/"
],
"categories": [
"Internet, Landline & TV",
"Smartphones",
"Mobile"
],
"countries": [
{
"country_code": "DE",
"name": "Germany"
}
],
"averageCommission": null,
"hasPostView": false,
"clickLink": "https://as.ad4m.at/ad/tur?gdpr_applies=0&gdpr_consent=&gdpr_pd=0&a=1267&b=REVIEW&c=https://o2online.de",
"activeAds": {
"deeplinkAds": 0,
"displayAds": 0,
"htmlAds": 454,
"linkAds": 1,
"nativeAds": 12
},
"max_sub_id_length": 130,
"network": "lead alliance",
"logoUrl": "https://assets.ad4m.at/logo/D694B3AB12381C049B127B34DC11A792684BA8B6EE8B598D6E4045678591B7D0DC6B2CEF7528F06BB05FC11826A1D16CF24DA68FCFC2416343996FBFC05A3155"
}
]
},
"errors": null,
"success": true
}

Response reference

Name

Description

averageCommission

Average commission in EUR of all transactions of this program.

max_sub_id_length

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

Did this answer your question?