Home API API for Statistics

API for Statistics

Last updated on Apr 04, 2025

This public API is designed to be offered to public offer listing sites like OfferVault, etc. to promote offers and attract publishers with suitable targeting, verticals and payout rates. The API is publicly available but requires a secure API key to access the offers. The API returns data is commonly used JSON format, easy to integrate to offer listing websites.

UCLIQ offer management API allows access to the existing offers, changing their properties, goals and payout values, add new items and schedule changes at certain times.

Generate API token

Before sharing the API link with an offer listing website, you need to generate a secure “Read-Only” token. You can do it in admin panel by going into System > Control Center > Platform >API Tokens menu and clicking on +Add token.

Select only the read permission and comment on the token usage. Make sure it is enabled.

Click on Save and copy the token into the clipboard.

Save the token securely.

API calls

General rules

  • All GET or POST requests require an Authentication token with Read/Write permission.

  • All POST, PATCH, DELETE requests require an Authentication token with Write permission

  • Archived offers, goals and payout cannot be retrieved or changed

STATISTIC API

Retrieve Publisher Statistics

General route: POST /manager/api/customer/v1/offer_goal_schedulers/{id}
Request header: X-AUTH-TOKEN
Parameters: sortFields=param&sortDirection=ASC|DESC
Request body example:

{

    "filters": {

        "dateRange": "2025-01-01T00:00:00.000+0100 - 2025-03-01T00:00:00.000+0100",

        "country": [

            "US",

            "UK"

        ]

    }

}

Request parameters:

  • sortFields - a field to sort the output

  • sortDirection - a direction of sorting

SortFields:

'clicks',

'conversions',

'pCr',

'epc',

'epm',

'groupId',

'groupName',

'hits',

'net',

'uClicks',

'uHits',

Filters:

'dateRange', - MANDATORY

'advertiserAccount',

'campaignRelativeId',

'category',

'country',

'device',

'domainNameLike',

'excludeAdvertiserAccount',

'excludeCampaignRelativeId',

'excludeCategory',

'excludeCountry',

'excludeDevice',

'excludeDomainNameLike',

'excludeManagerRelativeId',

'excludeOfferPromoGroupId',

'excludeOfferRelativeId',

'excludePrelandRelativeId',

'excludePublisherAliasId',

'excludePublisherRelativeId',

'excludeSmartlink',

'excludeSmartlinkVertical',

'excludeSubSourceLike',

'excludeTrafficType'

DateRange filter is mandatory, API won’t return data without a time span specified.

Response body example:

{

    "rows": [

        {

            "Clicks": "61",

            "Conversions": "9",

            "CR": 5,

            "pEPC": 0.03,

            "EPM": 20.66,

            "Hits": "61",

            "Net": 1.26,

            "uClicks": "43",

            "uHits": "43",

            "publisherId": 2,

            "username": "yellow"

        },

        {

            "Clicks": "47",

            "Conversions": "14",

            "CR": 1,

            "pEPC": 0.1,

            "EPM": 41.7,

            "Hits": "47",

            "Net": 1.96,

            "uClicks": "19",

            "uHits": "19",

            "publisherId": 1,

            "username": "blue"

        }

    ],

    "total": {

        "Clicks": 108,

        "Conversions": 23,

        "Hits": 108,

        "Net": 3.22,

        "uClicks": 62,

        "uHits": 62,

        "CR": 3,

        "pEPC": 0.052,

        "EPM": 29.81

    }

}

Example - request:

Example - response:

DICTIONARY API for filter values

While logged in in the Admin panel following requests to private web panel API can be used retrieve dictionary values for public API calls:

Example:

https://demoadmin.ucliq.com/manager/api/countries?page=1

{"@context":"\/manager\/api\/contexts\/Country","@id":"\/manager\/api\/countries","@type":"hydra:Collection","hydra:totalItems":256,

"hydra:member":[{"@id":"\/manager\/api\/countries\/XX","@type":"Country","code":"XX","name":"International"},

{"@id":"\/manager\/api\/countries\/CZ","@type":"Country","code":"CZ","name":"Czechia"},

{"@id":"\/manager\/api\/countries\/DE","@type":"Country","code":"DE","name":"Germany"},

{"@id":"\/manager\/api\/countries\/DK","@type":"Country","code":"DK","name":"Denmark"},

{"@id":"\/manager\/api\/countries\/SE","@type":"Country","code":"SE","name":"Sweden"},

{"@id":"\/manager\/api\/countries\/AT","@type":"Country","code":"AT","name":"Austria"},

{"@id":"\/manager\/api\/countries\/AF","@type":"Country","code":"AF","name":"Afghanistan"},

{"@id":"\/manager\/api\/countries\/AX","@type":"Country","code":"AX","name":"Åland Islands"},{"@id":"\/manager\/api\/countries\/AL","@type":"Country","code":"AL","name":"Albania"},

{"@id":"\/manager\/api\/countries\/DZ","@type":"Country","code":"DZ","name":"Algeria"},

{"@id":"\/manager\/api\/countries\/AS","@type":"Country","code":"AS","name":"American Samoa"},{"@id":"\/manager\/api\/countries\/AD","@type":"Country","code":"AD","name":"Andorra"},

{"@id":"\/manager\/api\/countries\/AO","@type":"Country","code":"AO","name":"Angola"},

{"@id":"\/manager\/api\/countries\/AI","@type":"Country","code":"AI","name":"Anguilla"},

...

,"popularCount":6}