For the complete documentation index, see llms.txt. This page is also available as Markdown.

Launch Campaigns Status

Check the status of a launch started via the Launch Campaigns endpoint.

Endpoint Details

URL: https://api.scalemate.co/api/external/v2/launch/:id

Method: GET

Headers

Content-Type: application/json
X-Api-Key: <YOUR_API_KEY>

You can generate the API Key at the Settings page under the API Key section.

Parameters

Parameter
Type
Description

id

string (required)

The job_id returned by the Launch Campaigns endpoint.

Example cURL Request

curl --location 'https://api.scalemate.co/api/external/v2/launch/63267564-2c14-4ccc-ab60-1a61a950a25d' \
--header 'X-Api-Key: <YOUR_API_KEY>'

Example Response

While the job is running:

After it completes, results holds the same payload delivered to your webhook (without job_id):

  • Top-level status — job lifecycle: pending, completed or failed.

  • results.status — launch outcome: success, partial or failed. partial means some ads failed — inspect the campaigns tree (a failed ad has "remote_id": null and an "error").

  • results is null until the job finishes.

See the Launch Campaigns endpoint for the full campaigns tree schema.

Last updated