Active Campaigns

API Endpoints

List of active campaign

Return list of activated Campaign

GET https://api.tyrads.com/publisher/campaigns

Example:

get

Query parameters

statusstring · enumOptional

Filter campaigns by status (allowed values: active, paused, or both comma-separated)

Example: activePossible values:

Header parameters

X-Api-KeystringOptionalExample: YOUR_API_KEY

X-Api-SecretstringOptionalExample: YOUR_API_SECRET

Responses

200

Status OK

application/json

get

/publisher/campaigns

HTTPcURLJavaScriptPython

GET /publisher/campaigns HTTP/1.1
Host: api.tyrads.com
Accept: */*

200

Status OK

{
  "data": [
    {
      "campaignId": 871,
      "campaignName": "2248: Example App / Android / WW / CPE",
      "capReached": false,
      "rankingScore": 4.5,
      "campaignDescription": null,
      "status": "active",
      "reportingCampaignName": "2248_Examle_Campaign_Name",
      "app": {
        "id": 467,
        "title": "2248: Example App",
        "packageName": "com.example.app",
        "rating": 4.76923,
        "shortDescription": "Enjoy playing our example application",
        "store": "googlePlay",
        "storeCategory": "Puzzle",
        "previewUrl": "https://play.google.com/store/apps/details?id=com.example.app",
        "thumbnail": "https://play-lh.googleusercontent.com/Tfd6l6CBu0l6UfEruAF6TDE6"
      },
      "currency": {
        "name": "USD",
        "symbol": "$"
      },
      "kpis": [
        {
          "id": 1319,
          "kpiType": "Soft",
          "eventType": "Event",
          "eventName": "Reach Step 100",
          "rules": [
            {
              "rule": "More Than",
              "goal": "100",
              "unit": "%",
              "criteriaFirst": "",
              "criteriaSecond": "",
              "payout": ""
            }
          ],
          "appEventId": 27,
          "appEventIdentifier": "c_03_reach_step_100"
        }
      ],
      "payoutEvents": [
        {
          "id": 4951,
          "identifier": "c_003_reach_step_100",
          "eventOrder": 1,
          "eventName": "Reach Step 100",
          "eventDescription": "15-45 mins",
          "eventCategory": "Custom",
          "payoutAmount": 0,
          "payoutTypeId": 2,
          "payoutType": "CPA",
          "allowDuplicateEvents": false,
          "enforceEventOrder": false,
          "enforceMinTimeCompletion": false,
          "enforceMaxTimeCompletion": false,
          "maxTime": 20,
          "maxTimeDuration": "days",
          "everflowEventId": 61655,
          "appEventId": 23456,
          "userPayout": 0.5
        }
      ],
      "publisherBudgets": [
        {
          "id": 5991,
          "budgetType": {
            "id": 3,
            "name": "Click Caps"
          },
          "dailyBudget": 0,
          "weeklyBudget": 0,
          "monthlyBudget": 0,
          "globalBudget": 0,
          "isActive": true
        }
      ],
      "tracking": {
        "id": 2437,
        "attributionTool": "Adjust",
        "clickUrl": "https://app.adjust.com/135scirc?campaign=...",
        "impressionUrl": "https://view.adjust.com/impression/135scirc?campaign=..."
      },
      "targeting": {
        "os": "Android",
        "countries": [
          {
            "id": 1,
            "iso": "AF"
          }
        ],
        "demographics": [
          {
            "id": 1,
            "category": "age-group",
            "target": "18 to 24"
          }
        ],
        "targetingType": "incent",
        "reward": {
          "rewardDifficulty": "Easy",
          "incentRewardDescription": ""
        }
      },
      "creative": {
        "creativeUrl": ".",
        "creativePacks": [
          {
            "creativePackName": "Creative_name",
            "languageName": "English",
            "languageCode": "en",
            "creatives": [
              {
                "creativeName": "Creative_name_en_NativeBanner_1200x627",
                "callToAction": "text",
                "text": "text",
                "byteSize": "76458",
                "fileUrl": "https://tyrads-creatives.s3.amazonaws.com/1695984438089.png",
                "duration": "text",
                "creativeType": {
                  "name": "Native Banner",
                  "type": "image",
                  "width": "1200",
                  "height": "627",
                  "creativeCategoryType": "Native"
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "message": "Ok"
}

To ensure a smooth experience for your users and prevent potential customer service issues related to capped campaigns, it is mandatory that you filter campaigns using the capReached parameter in our API response.

When a campaign's cap is fully reached, it will not be automatically removed from our API response. Therefore, you must apply a filter on your end so that only campaigns with capReached=false are shown to users. This will provide the most reliable and real-time prevention of showing capped campaigns to the user.

API References

Campaign

Attribute	Type	Description
campaignId	integer	Campaign ID
campaignName	string	Campaign name
capReached	boolean	Campaign is over cap or not.
rankingScore	float	Campaign ranking score. Campaigns in the response are sorted based on this field in descending order.
campaignDescription	string	Campaign description
status	string	Campaign status active, paused, or suspended
reportingCampaignName	string	Campaign name used within the MMP (Mobile Measurement Partner)
app	Campaign App	The advertiser app of the campaign
currency	Campaign Currency	The currency of the campaign
kpis	array of Campaign KPI	The KPIs (Key performance indicator) of the campaign
payoutEvents	array of PayoutEvent	The payout events of the campaign
publisherBudgets	array of Publisher Budget	The specific budgets for you as a publisher of a specific campaign
tracking	Campaign Tracking	The tracking of the campaign with the MMP (Mobile Measurement Partners) Links
targeting	Campaign Targeting	The targeting of the campaign
creative	Campaign Creative	The creatives of the campaign

Campaign App

Attribute	Type	Description
id	integer	Internal App ID
title	string	App Title from the appstore page
packagename	string	Application package name
rating	float | null	Rating from the appstore page
shortDescription	string | null	Short description from the appstore page
store	string	The store name of the application apple or googlePlay
storeCategory	string | null	Application category on store
previewUrl	string	The preview URL of the app from the appstore
thumbnail	string	The thumbnail URL of the app from the appstore

Campaign Currency

Attribute	Type	Description
name	string	Currency name
symbol	string	Currency symbol

Campaign KPI

Attribute	Type	Description
id	integer	The ID of the KPI
kpiType	string	The type of the KPI Soft, Hard, or Conditional Soft: Soft KPI are KPI's that are not payment related but need to achieved to keep the campaign active. Hard: HARD KPI's are related to payment if not achieved payment is not made. Conditional: Conditional Hard KPI's are KPI's that will payout a % of the amount based on the criteria.
eventType	string	The type of the KPI event ROI, Retention or Event
eventName	string	The name of the event to measure the KPI on.
rule	KPI Rule	The rule of the KPI

KPI Rule

Attribute	Type	Description
rule	string	The operator of the KPI rule Less Than, More Than, or Between
criteriaFirst	string	The first criteria of the KPI rule, only used for Conditional Hard KPI's
criteriaSecond	string	The second criteria of the KPI rule to combine with firstCriteria only if rule is Between only used for Conditional Hard KPI's
goal	string	The goal of the KPI rule mianly used for SOFT and HARD KPI's
unit	string	The unit of the KPI rule % or $
days	integer | null	The day the KPI will be avaluated for the performance to obtain if it was succesfull.
payout	float	The percentage of the payout when the criteria is met. Only used for Conditional Hard KPI's

Payout Event

Attribute	Type	Description
id	integer	The ID of the event
identifier	string	The unique identifier of the event
eventName	string	The name of the event
eventCategory	string	The category name of the event
payoutAmount	float	The payout amount of the event
payoutTypeId	integer	The payout type ID of the event
payoutType	string	The payout type name of the event
allowDuplicateEvents	boolean	If true the duplicate event will count
minTime	interger | null	The minimum time amount of the event to be count
minTimeMetric	string | null	The minimum time metric seconds, minutes, hours, or days
maxTime	interger | null	The maximum time amount of the event to be count
maxTimeMetric	string | null	The maximum time metric seconds, minutes, hours, or days
enforceEventOrder	boolean	If true the event need to follow the orderEvent to be count
enforceMinTimeCompletion	boolean	If true the event need to follow the minTime and minTimeMetric to be count
enforceMaxTimeCompletion	boolean	If true the event need to follow the maxTime and maxTimeMetric to be count
everflowEventId	integer	The ID of everflow event
appEventId	integer	The App Event Id
userPayout	float | null	User payout amount of the event
order	Integer	Order of the event in campaign.

Publisher Budget

Attribute	Type	Description
id	integer	Budget ID
budget	Publisher Budget Type	The type of budget, click, conversion, revenue and payouts budgets
dailyBudget	integer | null	Budget limit per day
weeklyBudget	integer | null	Budget limit per week
monthBudget	integer | null	Budget limit per month
globalBudget	integer | null	Total Budget limit without time limit
isActive	boolean	Budget active status

Publisher Budget Type

Attribute	Type	Description
id	integer	Budget type ID
name	string	Budget type name

Campaign Tracking

Attribute	Type	Description
id	integer	Campaign tracking ID
attributionTool	string	Attribution tool of the campaign Appsflyer, Adjust, Branch, Singular, or Other
impressionUrl	string	Campaign tracking URL for impression
clickUrl	string	Campaign tracking URL for click

Campaign Targeting

Attribute	Type	Description
os	string	The OS target of the campaign Android or iOS
countries	array of Country	List of countries to target for the campaign
demographics	array of Demographic	List of demographics to target for the campaign
targetingType	string	The traffic targeting type of the campaign incent, non-incent or both
reward	Targeting Reward	The reward of the campaign if targetingType is incent or both

Country

Attribute	Type	Description
id	integer	Country ID
iso	string	Country ISO code

Demographic

Attribute	Type	Description
id	integer	Target demographic ID
category	string	Target demographic category gender or age-group
target	string	Depend on the value of category Options for gender: Male Female Options for age-group: 12 to 17 18 to 24 25 to 34 35 to 44 45 to 54 55 to 64 65+

Targeting Reward

Attribute	Type	Description
rewardDifficulty	string	The difficulty of the reward Easy, Medium, or Hard
incentRewardDescription	string	The description of the reward

Campaign Creative

Attribute	Type	Description
creativeUrl	string	The creative URL to download all the creatives
creativePacks	array of Creative Pack	List of creative packs

Creative Pack

Attribute	Type	Description
creativePackName	string	The creative pack name
languageName	string	The language of the creative pack
languageCode	string	The language code of the creative pack
creatives	array of Creative	List of creatives within the creative pack.

Creative

Attribute	Type	Description
creativeName	string	The creative name
callToAction	string | null	The text of the ad button for the Call to Action (CTA)
byteSize	string	The size of the creative file in bytes
fileUrl	string	The URL of the creative file.
duration	string | null	The duration of the ad (mainly used for video creatives)
creativeType	Creative Type	The type of the creative

Creative Type

Attribute	Type	Description
name	string	The creative type name
type	string	The creative file type images or videos
width	string | null	The width of the creative in pixel. null if type is text
height	string | null	The height of the creative in pixel. null if type is text
creativeCategoryType	string	The category type of the creative.