v22

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-12131543.9 KB
Campaign

Fetch All Campaigns

Returns all publisher campaigns

Goal: Any additional event added in the campaign is goal

Default Goal: Default event of the campaign

Note: There will be no goal value in default goal, only goal have the goal values.

Rate Limit: 5 req/sec

get/v2/publisher/campaigns

Query parameters

pageinteger

Page number result to fetch

limitinteger

Number of result to fetch in one call (Default => 1000)

apiKeystring

Publisher API Key

categories[]string

Category names

showApproved1 | 0

Show Approved Offers

Response

Successful operation

successboolean

Response status

Example response

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": 18,
        "title": "AppAttribution CPI-Incent",
        "description": "AppAttribution mobile app platform",
        "kpi": "mobile app platform",
        "currency": "USD",
        "categories": [
          "Technology",
          "Bollynews"
        ],
        "subIdsBlock": [
          "XF152asd",
          "TF152asd"
        ],
        "subIdsAllow": [
          "XF152asd",
          "TF152asd"
        ],
        "preview_url": "https://play.google.com/store/apps/details?id=io.appattribution.device",
        "model": "cpi",
        "flow": [
          "MO Flow"
        ],
        "os_version": {
          "ios": {
            "min": "4.1",
            "max": "9"
          },
          "android": {
            "min": "4.1",
            "max": "9"
          },
          "windowsphone": {
            "min": "4.1",
            "max": "9"
          },
          "all": {
            "min": "4.1",
            "max": "9"
          }
        },
        "app_id": "io.appattribution.app",
        "app_name": "AppAttribution - Mobile App Tracking",
        "tracking_link": "https://trk.trackier.com/5acdefeadcxwe3dsad?p1={your-transaction-id}&source={your-sub-aff-id}",
        "impressionUrl": "https://demo.trackier.net/imp?campaign_id=20931&pub_id=31",
        "bot_check_url": "https://a762.botninja.js?https://demo.trackier.net/5acdefeadcxwe3dsad",
        "countries": [
          "US",
          "IN"
        ],
        "isps": [
          "SpectraNet",
          "ASN"
        ],
        "citiesInclude": [
          "Kolkata",
          "Delhi"
        ],
        "citiesExclude": [
          "Kolkata",
          "Delhi"
        ],
        "defaultGoal": "Install",
        "payouts": [
          {
            "payout": 1.87,
            "fixedPayout": 1.87,
            "geo": [
              "US",
              "IN"
            ],
            "city": [
              "Mohali"
            ],
            "region": [
              "Punjab"
            ],
            "allowedValues": [
              "sub1-testing",
              "sub2-testing"
            ],
            "variable": "source"
          }
        ],
        "goals": [
          {
            "id": "5cebd00db6920d7e89622ccf",
            "title": "Purchased",
            "value": "Purchased",
            "payout_model": "fixed",
            "payouts": [
              {
                "payout": 1.87,
                "fixedPayout": 1.87,
                "geo": [
                  "US",
                  "IN"
                ],
                "city": [
                  "Mohali"
                ],
                "region": [
                  "Punjab"
                ],
                "allowedValues": [
                  "sub1-testing",
                  "sub2-testing"
                ],
                "variable": "source"
              }
            ]
          }
        ],
        "creatives": [
          {
            "mime_type": "image/png",
            "file_name": "5b505e7d8213e.png",
            "title": "Static Image",
            "full_url": "https://static.vnative.co/images/5b505e7d8213e.png",
            "dimensions": {
              "width": 200,
              "height": 400
            }
          }
        ],
        "cap": {
          "type": "conversion",
          "monthly": 928
        },
        "landingPage": [
          {
            "title": "test",
            "type": "landing"
          }
        ]
      }
    ],
    "page": 1,
    "count": 251
  }
}
All 13 operations