Search...
Menu

API: Retrieve Campaign List (Technical Guide)

Label：API ,campaign list ,developer guide ,API key

You need to use your Mintegral token to manage your campaigns. For more details, please check Token.

Acquire campaign list, support inquiry according to campaign_id、campaign_name、package_name

Request address

https://ss-api.mintegral.com/api/open/v1/campaign

Request method

GET

Request example

json Copy 
GET /api/open/v1/campaign
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "page": 1, "campaign_id": "1230,1231,1532", "limit": 10 }

Request Parameter

Fields Type Explanations Default Value Examples
campaign_id Optional int Unique id for campaign. Separate with commas for multiple campaign.
Note: the maximum number for one search is 50.		 — "1230,1231,1532"
campaign_name Optional string Short description for campaign — "campaign_test"
package_name Optional string Package name of app — "test"
offer_id Optional int Unique id for offer — 1234"
offer_name Optional string Unique name for offer — "offer_test"
offer_uuid Optional string Unique offer name generated automatically — "ss_offer_test"
page Optional int Page 1 1
limit Optional int Limit for each page.Maximum: 50
>50, return to 50		 10 15

Response

Fields Type Explanations
code int 200 code, is success. Others, are fail.
msg string If success, return to "success". If fail, return to detailed wrong info.
data json If success, return to campaign data. If fail, return to detailed wrong info.
page int current page
limit int quantity limit
total int total amount
list array<json>
campaign_id int Unique ID for campaign
campaign_name string Campaign name you add
is_coppa string The value of COPPA setting
promotion_type string Promotion type you set
alive_in_store string The value you set of “alive in store”
preview_url string Preview link you add in campaign
product_name string Ads objective name
package_name string IOS app store id or buddle id of the application you want to promote
description string Description of ads objective
icon string Md5 of icon or logo
platform string Platform of campaign
category string Category of campaign
app_size string Size of application
min_version string The minimum system version you set in campaign
maintain_by string Access of modifying offer. If maintain_by="AM", it means you can only check the details of your campaign or offer. If maintain_by="ADV", you can change the setting of your campaign or offer freely.
status string Campaign Status. Enum value in [ENUM - Campaign Status]

Response Example

json Copy 
{
  "msg": "success",
  "code": 200,
  "data": {
    "page": 1,
    "limit": 10,
    "total": 2,
    "list": [
      {
        "campaign_id": 1234,
        "is_coppa": "YES",
        "campaign_name": "Test",
        "promotion_type": "APP",
        "alive_in_store": "YES",
        "preview_url": "https://play.google.com/store/apps/details?id=xxxxxxx",
        "product_name": "Test",
        "package_name": "com.tencent.mm",
        "description": "Test",
        "icon": "f7c970d0d24c71d84d15a78f29042323",
        "platform": "ANDROID",
        "category": "BUSINESS",
        "app_size": "12.13",
        "min_version": "1.0.0",
        "maintain_by": "ADV"
      },
      {
        "campaign_id": 1235,
        "is_coppa": "YES",
        "campaign_name": "Test",
        "promotion_type": "APP",
        "alive_in_store": "YES",
        "preview_url": "https://play.google.com/store/apps/details?id=xxxxxxx",
        "product_name": "Test",
        "package_name": "com.tencent.mm",
        "description": "Test",
        "icon": "f7c970d0d24c71d84d15a78f29042323",
        "platform": "ANDROID",
        "category": "BUSINESS",
        "app_size": "12.13",
        "min_version": "1.0.0",
        "maintain_by": "ADV"
      }
    ]
  }
}
Previous
API: Managing Campaigns (Technical Guides)
Next
API: Creating Campaigns (Technical Guide)
Last modified: 2025-08-28