Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview

Get one campaign

Gives the payload the provider reports for one campaign, exactly as the provider sent it. This is the escape hatch from the normalized fields: bid strategy, schedule, spending limits, and everything else AdCrunch does not model. The budget and the objective are normalized on every listed row.

The keys are the provider’s. A TikTok campaign answers campaign_id, campaign_name, objective_type and budget_mode; a Meta campaign answers id, name, objective and daily_budget.

When there is nothing to give

Two different empty answers, and they mean different things.

  • 200 with an empty body — AdCrunch does not know this campaign, it belongs to another advertiser, or your organization does not own the advertiser in the path. They are deliberately not told apart: distinguishing them would confirm that a campaign exists to somebody who cannot read it.
  • 404 — AdCrunch knows the campaign but holds no stored payload for it. It is a fresh row whose payload has not landed yet.

Neither is an error on your side. Only the 404 is likely to change on a retry.

GET/observe/{advertiserId}/campaigns/{id}
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Path parameters
advertiserIdstringrequired
matches ^(acc_)[\s\S]{0,}$
idstringrequired
Responses
200

The provider’s payload. The body is empty when AdCrunch does not know the campaign, when it belongs to another advertiser, or when your organization does not own the advertiser named in the path.

any
401

No credential, or one that does not resolve. Send an API key or a session. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold observe:read. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

AdCrunch knows the entity but holds no stored payload for it. This body is the framework’s own — the plain text NOT_FOUND, not the error/message shape every AdCrunch failure takes (ADR 0045).

string
422

The request did not match this operation’s schema. This is the framework’s own shape, not the error/message one.

errorsobject[]required

One entry per failing field.

foundanyrequired

What was sent.

messagestringrequired
onstringrequired

Which part of the request failed: body, query or params.

propertystringrequired

The field that failed.

typestringrequired
Allowed:validation
Request
curl -X GET "https://api.adcrunch.dev/observe/string/campaigns/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
The provider’s payload. The body is **empty** when AdCrunch does not know the campaign, when it belongs to another advertiser, or when your organization does not own the advertiser named in the path.