List ad campaigns for a company

Lists all ad campaigns for a company, optionally filtered by status and/or the ad they reference.

GET/v1/hq/companies/{company_id}/ad_campaigns

Authorization

AuthorizationBearer <token>

The Noona HQ API uses Bearer token for authentication.

Endpoints that return generic information that does not contain sensitive data do not require authentication. Endpoints that require authentication are specifically marked in the documentation.

Authorization: Bearer your-token

In: header

Path Parameters

company_id*string

Query Parameters

status?string

Value in"active" | "paused" | "ended"

ad_id?string

Filter to campaigns whose promotables reference this ad

select?array<string>

Field Selector

expand?array<string>

Expandable attributes

Response Body

application/json

curl -X GET "https://api.noona.is/v1/hq/companies/string/ad_campaigns"

curl -X GET "https://api.noona.is/v1/hq/companies/string/ad_campaigns"

[
  {
    "id": "string",
    "company": "string",
    "name": "string",
    "status": "active",
    "budget": {
      "daily": {
        "amount": 10000,
        "currency": "ISK"
      },
      "total": {
        "amount": 500000,
        "currency": "ISK"
      }
    },
    "schedule": {
      "starts_at": "2019-08-24T14:15:22Z",
      "ends_at": "2019-08-24T14:15:22Z"
    },
    "targeting": {
      "location": {
        "lat": 0.1,
        "lng": 0.1
      },
      "radius": 0
    },
    "promotables": [
      {
        "type": "ad",
        "ad": {
          "ad_id": "string"
        }
      }
    ],
    "spend": {
      "total": {
        "amount": 50000,
        "currency": "ISK"
      },
      "today": {
        "amount": 5000,
        "currency": "ISK"
      },
      "today_date": "string"
    },
    "paused_for_day": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "effective_status": "pending_review",
    "starts_at": "2019-08-24T14:15:22Z"
  }
]

Empty