Campaigns - API Docs

Get a list of Campaigns

get

/campaigns

Query Parameters

limit int	The number of items returned in the response. Defaults to 100.
offset int	The number of items to skip before starting to return results. Defaults to 0.

Example Request

curl "https://{yourname}.api.adglare.app/v2/campaigns"
-H "Content-Type: application/json"
-H "x-api-key: {api_key}"

Example Response

{
    "items": [{
        "account_id_created": 685576430,
        "account_id_modified": 764685530,
        "ad_format": "display",
        "advertiser_id": 0,
        "campaign_id": 279481212,
        "conversion_tracker_id": 0,
        "created": 1687144690,
        "creative_ids": [210267475,
        747210265],
        "creative_optimization": [],
        "delivery": {
            "end": 0,
            "start": 1687144690
        },
        "event_counts": {
            "ad_requests": 6374726,
            "clicks": 5247,
            "filled_impressions": 6374726,
            "impressions": 6825202,
            "measurable_impressions": 6825202,
            "viewable_impressions": 4124992
        },
        "folder_id": 672728731,
        "is_active": true,
        "is_archived": false,
        "metadata": [],
        "modified": 1727764402,
        "name": "Test campaign",
        "notes": "",
        "pacing": [],
        "pricing": [],
        "targeting": [],
        "tier": 1,
        "watchlist": [],
        "weight": 5,
        "zone_ids": [433441350]
    },
    {
        "account_id_created": 857566430,
        "account_id_modified": 685576430,
        "ad_format": "display",
        "advertiser_id": 0,
        "campaign_id": 042527393,
        "...": "..."
    }
}

Get a single Campaign

get

/campaigns/{id}

Path Parameters

id

int, required

The ID of the campaign.

Example Request

curl "https://{yourname}.api.adglare.app/v2/campaigns/{id}"
-H "Content-Type: application/json"
-H "x-api-key: {api_key}"

Example Response

{
    "account_id_created": 685576430,
    "account_id_modified": 764685530,
    "ad_format": "display",
    "advertiser_id": 0,
    "campaign_id": 279481212,
    "conversion_tracker_id": 0,
    "created": 1687144690,
    "creative_ids": [210267475,
    747210265],
    "creative_optimization": [],
    "delivery": {
        "end": 0,
        "start": 1687144690
    },
    "event_counts": {
        "ad_requests": 6374726,
        "clicks": 5247,
        "filled_impressions": 6374726,
        "impressions": 6825202,
        "measurable_impressions": 6825202,
        "viewable_impressions": 4124992
    },
    "folder_id": 672728731,
    "is_active": true,
    "is_archived": false,
    "metadata": [],
    "modified": 1727764402,
    "name": "Test campaign",
    "notes": "",
    "pacing": [],
    "pricing": [],
    "targeting": [],
    "tier": 1,
    "watchlist": [],
    "weight": 5,
    "zone_ids": [433441350]
}

Create a Campaign

post

/campaigns

Request Body (JSON)

name string, required	The name of the campaign.
workspace_id int, required	The workspace ID of the campaign.
folder_id int, required	The folder ID of the campaign.
ad_format string, required	The ad format: display, native, vast, redirect

Example Request

curl "https://{yourname}.api.adglare.app/v2/campaigns"
  -X POST
  -H "Content-Type: application/json"
  -H "x-api-key: {api_key}"
  -d '{
    "name": "My Campaign",
    "workspace_id": "123456789",
    "folder_id": "123456789",
    "ad_format": "display",
  }'

Example Response

{
"campaign_id": 685576430
}

Delete a Campaign

delete

/campaign/{id}

Path Parameters

id

int, required

The ID of the campaign.

Example Request

curl "https://{yourname}.api.adglare.app/v2/campaign/{id}"
-X DELETE
-H "x-api-key: {api_key}"

Example Response

{}