Zones - API Docs

Get a list of Zones

get

/zones

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.

cURL

curl "https://{yourname}.api.adglare.app/v2/zones"
-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",
        "campaign_ids": [279481212],
        "created": 1687148279,
        "data": {
            "auto_refresh": {
                "interval": 20,
                "times": 24
            },
            "lazy_loading": false
        },
        "event_counts": {
            "ad_requests": 10230781,
            "clicks": 8214,
            "filled_impressions": 10217567,
            "impressions": 10209912,
            "measurable_impressions": 9755528,
            "unfilled_impressions": 12486,
            "viewable_impressions": 6076664
        },
        "folder_id": 796278613,
        "is_active": true,
        "metadata": [],
        "modified": 1727763923,
        "name": "Dashboard",
        "notes": "",
        "pricing": {
            "model": null,
            "value": null
        },
        "watchlist": [],
        "zone_id": 433441350
    },
    {
        "account_id_created": 645685730,
        "account_id_modified": 685764530,
        "ad_format": "display",
        "...": "..."
    }
}

Get a single Zone

get

/zones/{id}

Path Parameters

id

int, required

The ID of the zone.

Example Request

curl "https://{yourname}.api.adglare.app/v2/zones/{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",
    "campaign_ids": [279481212],
    "created": 1687148279,
    "data": {
        "auto_refresh": {
            "interval": 20,
            "times": 24
        },
        "lazy_loading": false
    },
    "event_counts": {
        "ad_requests": 10230781,
        "clicks": 8214,
        "filled_impressions": 10217567,
        "impressions": 10209912,
        "measurable_impressions": 9755528,
        "unfilled_impressions": 12486,
        "viewable_impressions": 6076664
    },
    "folder_id": 796278613,
    "is_active": true,
    "metadata": [],
    "modified": 1727763923,
    "name": "Dashboard",
    "notes": "",
    "pricing": {
        "model": null,
        "value": null
    },
    "watchlist": [],
    "zone_id": 433441350
}

Create a Zone

post

/zones

Request Body (JSON)

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

Example Request

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

Example Response

{
"zone_id": 764306855
}

Delete a Zone

delete

/zones/{id}

Path Parameters

id

int, required

The ID of the zone.

Example Request

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

Example Response

{}