AdnovaDocs
Ad Launcher

Get launch

Returns the current state of a Launch Batch. Poll at the retryAfterSeconds cadence from Create a launch until terminal. partially_completed means some ads launched and some failed — check each ad's launched[] entry.

GET
/meta/launches/{batchId}

Authentication

authentication
api-key<token>

Create an API key from the Adnova dashboard (Account integrations). Pass the key value in the api-key request header on every call.

In: header

Path Parameters

batchId*string
Length1 <= length

Query Parameters

adAccountId*string

Ad account this batch was launched against. Required so the per-ad-account access check can run.

Length1 <= length

Header Parameters

x-workspace-id*string

Workspace the request operates in. Get it from List workspaces.

Length1 <= length
x-org-id*string

Organization context (required on every endpoint). For lookup endpoints the org is derived from the ad account in the URL, so any org id you have access to is accepted.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.adnova.ai/ad-launcher/v1/meta/launches/string?adAccountId=string" \  -H "x-workspace-id: string" \  -H "x-org-id: string"
{
  "_id": "01H8YB...",
  "platform": "meta",
  "adAccountId": "01H8Y4...",
  "accountId": "1234567890",
  "status": "pending",
  "ads": [
    {
      "id": "01HQK7M8N3VC8D4R6Z2E5J7B9P",
      "adName": "string",
      "adSets": [
        "string"
      ],
      "launchedAdDetails": [
        {
          "adId": "120208....",
          "adsetId": "120208....",
          "status": "completed",
          "effectiveStatus": "string",
          "error": "string",
          "fbError": [
            {}
          ]
        }
      ]
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedBy": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}