Campaign API

WARNING

Authentication token is required when calling this API. See Token Usage Guide for details.

Request URL

https://scaler.taurusx.com/openapi/campaign_info

Request Method

GET

Request Parameters

FieldRequiredTypeDefaultDescription
campaign_idsNostring-Campaign IDs, separated by commas (,)
pageYesint1Page number, must be an integer ≥ 1
page_sizeYesint50Number of records per page, maximum value is 100

Response Field Description

Field NameParentTypeDescription
code-intStatus code: 200 indicates success; other values indicate failure
data-jsonData object
data_listdataarray<json>Array of campaign information
campaign_iddata_liststringCampaign ID
campaign_namedata_liststringCampaign name
promote_goaldata_liststringPromotion goal: APP for App Promotion | WEB for Web Promotion
budget_typedata_liststringBudget type: total (Total Budget) | daily (Daily Budget) | unlimited
budgetdata_listnumberBudget value; -1 indicates unlimited budget

Example Response

json
{
  "code": 200,
  "data": {
    "data_list": [
      {
        "campaign_id": 138,
        "campaign_name": "E-commerce Promotion",
        "promote_goal": "APP",
        "budget_type": "total",
        "budget": 100
      }
    ],
    "total": 1
  },
  "msg": "ok"
}
{
  "code": 200,
  "data": {
    "data_list": [
      {
        "campaign_id": 138,
        "campaign_name": "E-commerce Promotion",
        "promote_goal": "APP",
        "budget_type": "total",
        "budget": 100
      }
    ],
    "total": 1
  },
  "msg": "ok"
}