API

API

The UCLIQ API provides a robust interface for managing offers, schedulers, and associated data. Designed for integration with public offer listing sites and internal systems, it allows you to automate tasks like retrieving offers, managing payouts, and scheduling changes. This guide explains how to use the API, including setup, endpoints, and key operations. Overview of the UCLIQ API The UCLIQ API offers the following capabilities: - Access and manage offers, goals, and payouts. - Filter offers for specific verticals, countries, or targeting groups. - Automate scheduling of updates like payout adjustments. - Enable integration with third-party platforms such as OfferVault. The API supports JSON data exchange and uses secure API tokens for authentication. Getting Started Generate API Token 1. Log in to the UCLIQ Manager Portal. 2. Navigate to System > Control Center > Platform > API Tokens. 3. Click + Add Token. 4. Select the desired permissions: Read-only for retrieving data. Write for updating or creating entries. 5. Save and copy the token securely. This token is required for all API requests. General Rules for API Calls Authentication: Include the token in the request header using X-AUTH-TOKEN. HTTP Methods: - GET for retrieving data. - POST for creating new entries. - PATCH for updating entries. - DELETE for removing entries. Archived Data: Archived offers, goals, and payouts cannot be retrieved or modified. Offer Management Retrieve Offer Listings - Endpoint: GET /manager/api/customer/v1/offers - Headers: X-AUTH-TOKEN - Response: A list of offers, including details like title, description, payout, and targeting information. Example response: { "id": 1, "title": "Demo Offer 1", "description": "Offer details here", "currency": "USD", "payout": "$10.1", "vertical": ["Demo BizOps"], "country": ["US"], "denied_country": [] } Filter Offers by Tags - Add a parameter to filter offers by tags: GET /manager/api/customer/v1/offers?tag[]=value Retrieve Offer Details - Endpoint: GET /manager/api/customer/v1/offers/{OfferId} TIPS Secure API Tokens: Store tokens securely and avoid sharing them publicly. Use Filters: Narrow down data retrieval by using tags or parameters to avoid unnecessary payloads. Test Your Integration: Use tools like Postman to test API calls before integrating them into production. Respect Rate Limits: Ensure your requests align with the platform's rate-limiting policies. Troubleshooting - 401 Unauthorized: Check if the API token has the correct permissions and is included in the header. - 400 Bad Request: Verify the request format, endpoint, and parameters. - 500 Server Error: Retry the request or contact UCLIQ support for assistance. Examples of Use Cases 1. Automating Offer Updates Schedule payout changes for specific offers to optimize performance. 2. Integrating with Third-Party Platforms Share offer details with sites like OfferVault to attract more publishers. 3. Real-Time Analytics Retrieve offer data for internal dashboards to monitor performance. For more details or help with API integration, refer to the full API documentation or contact UCLIQ support.

Scheduler API

Schedulers are used to automate updates for goals or offers, such as changing payout values. Retrieve Scheduler Listings - Endpoint: GET /manager/api/customer/v1/offer_goal_schedulers - Headers: X-AUTH-TOKEN - Returns a list of schedulers, including the offer goal, status, and scheduled update time. Create a New Scheduler - Endpoint: POST /manager/api/customer/v1/offer_goal_schedulers - Headers: X-AUTH-TOKEN - Request Body: { "offerGoal": "/manager/api/offer_goals/39", "value": 12, "updateAtDatetime": "2024-01-01T23:59:59+0200" } Update a Scheduler - Endpoint: PATCH /manager/api/customer/v1/offer_goal_schedulers/{id} - Headers: - Content-Type: application/merge-patch+json - X-AUTH-TOKEN - Request Body: { "status": 1, "value": 2147483647, "updateAtDatetime": "2024-06-14T08:04:12.890Z" } Delete a Scheduler - Endpoint: DELETE /manager/api/customer/v1/offer_goal_schedulers/{id}

API for Statistics

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: - Country list - https://demoadmin.ucliq.com/manager/api/countries?page=1 - Publisher list - https://demoadmin.ucliq.com/manager/api/publishers/filter?page=1&status[]=1&status[]=2 - Offer list - https://demoadmin.ucliq.com/manager/api/offers/filter?page=1&status[]=1&status[]=-1&status[]=0 - Smartlink list - https://demoadmin.ucliq.com/manager/api/smartlink_verticals/filter?page=1 - Tags list - https://demoadmin.ucliq.com/manager/api/tags/filter?page=1 - Device list - https://demoadmin.ucliq.com/manager/api/devices?page=1 - Categories list - https://demoadmin.ucliq.com/manager/api/categories/filter?page=1 - Advertiser list - https://demoadmin.ucliq.com/manager/api/advertisers/filter?page=1 - Manager list - https://demoadmin.ucliq.com/manager/api/users/publisher_managers?page=1 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}