REST API · Bridge

Get bridge transfer

Where a Bridge transfer is: prepared, running, completed, partial, failed, not_run or unknown

GEThttps://api.apogee.ad/api/v1/bridge-transfers/{id}

Scope: read Pro and Scale plans Credits: Free*

Request

GET /bridge-transfers/{id} on https://api.apogee.ad/api/v1.

Path parameters

id string path required

Bridge transfer 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.

id string
status string

One of prepared, running, completed, partial, failed, not_run, unknown, expired
finished boolean
ads_created number or null
adsets any
campaigns number or null
failures array of strings
error string or null
may_have_written boolean
started_at string or null
at string or null
ready boolean
expires_at 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).

Status	Possible codes
400 Bad request	`idempotency_key_required`, `not_supported`, `request_refused`, `validation_failed`
401 Unauthorized	`invalid_api_key`
403 Forbidden	`account_not_connected`, `forbidden`, `insufficient_scope`, `meta_permission_denied`, `platform_permission_denied`, `upgrade_required`
404 Not found	`not_found`
429 Too many requests	`daily_read_cap`, `meta_rate_limited`, `platform_rate_limited`, `quota_exceeded`, `rate_limited`
500 Internal server error	`internal_error`

Example

With your key in APOGEE_API_KEY (create one):

Request

curl 'https://api.apogee.ad/api/v1/bridge-transfers/120200000000000001' \
  -H "Authorization: Bearer $APOGEE_API_KEY"

Response 200 (shape)

{
  "id": "120200000000000001",
  "finished": false,
  "status": "prepared",
  "ads_created": 1,
  "adsets": "120200000000000001",
  "campaigns": 1,
  "failures": [
    "120200000000000001"
  ],
  "error": "120200000000000001",
  "may_have_written": false,
  "started_at": "2026-10-23T09:00:00.000Z",
  "at": "2026-10-23T09:00:00.000Z",
  "ready": false,
  "expires_at": "2026-10-23T09:00:00.000Z"
}

Access and cost

Plans	Pro and Scale.
Scope	`read` (scopes).
Credits	Free 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 limit	Read: 600 per 15 minutes on Pro, 1,200 on Scale (rate limits).

In the MCP

An AI assistant does the same with this tool of the MCP server:

bridge_transfer_status: Where a transfer is: running, completed, partial (with the failures), failed, not run, or unknown (check the destination before running it again).

Create bridge transfer: POST /bridge-transfers
Confirm bridge transfer: POST /bridge-transfers/{id}/confirm
List bridged ads: GET /bridged-ads
Get bridge stats: GET /bridged-ads/stats
Get bridge daily stats: GET /bridged-ads/daily-stats

Request

Path parameters

Headers

Response

Errors

Example

Access and cost

In the MCP

Related operations