Docs menu

REST API · Launches

Get launch

Where a launch is: processing, completed, failed or interrupted (a deploy cut it: check Ads Manager)

GEThttps://api.apogee.ad/api/v1/launches/{id}

Request

GET /launches/{id} on https://api.apogee.ad/api/v1.

Path parameters

  • id string path required

    Launch id

    1 to 64 characters

    Matches ^[\w-]+$

Headers

  • Authorization string header required

    Bearer apk_…: an API key with the scope of this route.

Response

200.

  • finished boolean
  • status string

    One of not launched, starting, processing, completed, failed, interrupted

  • id string or null
  • plan_id string or null
  • files object
    Fields (3)
    • total number or null
    • completed number or null
    • failed number or null
  • result object or null
    Fields (5)
    • success boolean
    • summary object
    • adsets array of objects
      Fields of each item (2)
      • id string or null
      • name string or null
    • ads_ok array of strings
    • errors any
  • interrupted_at string or null
  • note string or null
  • error string or null

Every answer carries X-Request-Id (give it to support), Apogee-Version: 2026-10-06, and the RateLimit and RateLimit-Policy headers.

Errors

Errors are application/problem+json with a stable code to switch on (all the codes).

Example

With your key in APOGEE_API_KEY (create one):

Request
curl 'https://api.apogee.ad/api/v1/launches/120200000000000001' \
  -H "Authorization: Bearer $APOGEE_API_KEY"
Response 200 (shape)
{
  "id": "120200000000000001",
  "plan_id": "7b0f3c52-4d1e-4c8a-9f61-2a5e8d3c1b90",
  "finished": false,
  "status": "not launched",
  "files": {
    "total": 3,
    "completed": 3,
    "failed": 0
  },
  "result": {
    "success": false,
    "summary": {},
    "adsets": [
      {
        "id": "120200000000000001",
        "name": "Nordlicht | Spring launch"
      }
    ],
    "ads_ok": [
      "120200000000000001"
    ],
    "errors": "120200000000000001"
  },
  "interrupted_at": "2026-10-23T09:00:00.000Z",
  "note": "Example text",
  "error": "120200000000000001"
}

Access and cost

PlansPro and Scale.
Scoperead (scopes).
CreditsFree up to the daily free reads (5,000 a day on Pro, 10,000 on Scale), then 1 credit per read. A request that fails costs nothing, a replayed one neither (credits).
Rate limitRead: 600 per 15 minutes on Pro, 1,200 on Scale (rate limits).
Daily capCounts 1 unit toward the 2,000 units one API key can use in 24 hours.

Last updated on . The parameters, limits, credits and error codes of these pages are generated from the code of the Apogee API (contract 2026-10-06).

A question, something missing? Write to hello@apogee.ad.

Book a demo

Pick the time that suits you.

Open in a new tab

Loading the calendar…

Talk to Founder