Campaigns

get/api/v2/campaigns

Request

  • Base URL: https://api.richads.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.richads.com/api/v2/campaigns
  • Auth: HTTP bearer

Query parameters

pageinteger
perPageinteger
status'active' | 'paused'
channel'push' | 'pops' | 'display' | 'telegram' | 'xml_native'
searchstring

Response

Paginated campaign list

Example response

{
  "data": [
    {
      "id": 12345,
      "status": "active",
      "type": "push",
      "name": "My Push Campaign",
      "targeting": {
        "country": "USA",
        "deviceTypes": [
          "Mobile",
          "Tablet",
          "Desktop"
        ]
      },
      "budget": {
        "budgetAmount": 100,
        "pacingType": "even",
        "budgetPeriod": "perDay",
        "cpaGoal": 2.5,
        "maxBid": 0.15
      },
      "sources": {
        "list": [
          1,
          5,
          12
        ],
        "whiteList": [
          "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
          "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3"
        ],
        "blockList": [
          "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
          "d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1"
        ]
      }
    }
  ],
  "pagination": {
    "totalPages": 3,
    "page": 1,
    "perPage": 20,
    "totalItems": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.