Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview

List the Campaign Plans that use a Creative

Lists the Campaign Plans whose pool holds a Creative of the Library, newest first. A Campaign Plan holds a pool of Creatives of the Library, at most 50. Each Line Item of the plan picks its Creatives from the pool, at most 20. The ads of a Line Item are built from the Creatives of that Line Item only. A Creative of the pool that no Line Item uses is not assigned yet.

Each plan has its slug and name, and lineItems: the live Line Items of that plan that use the Creative, each with its id and name. An empty lineItems means that the plan holds the Creative in its pool and no Line Item uses it yet. A deleted plan and a deleted Line Item are not listed.

An unknown Creative, a deleted one and the Creative of another organization answer 404, so this API does not confirm that an id exists somewhere else. This read gives no Variation and no Asset: they are in the Library, GET /library/creatives/{creativeId}.

One page at a time: limit rows at most, 100 by default. When the answer holds nextCursor, more rows exist: send it back as cursor to get the next page. A cursor of another Creative is refused.

GET/context/creatives/{creativeId}/campaign-plans
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Path parameters
creativeIdstringrequired

The id of a Creative in the Library of your organization, crv_…. List the Creatives with GET /library/creatives.

matches ^crv_[\s\S]{0,}$
Query parameters
cursorstring

The nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor.

min length 1
limitintegerrequired

The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request.

min 1 · max 500 · default: 100
Responses
200

One page of the Campaign Plans that use the Creative, newest first. This page is the last one, so it carries no nextCursor.

dataobject[]required
Show properties
Array of object
idstringrequired

The id of the Campaign Plan, cpl_….

lineItemsobject[]required

The live Line Items of the plan that use the Creative, oldest link first. Empty when the plan holds the Creative in its pool and no Line Item uses it yet.

Show properties
Array of object
idstringrequired

The id of the Line Item, lni_….

namestring | nullrequired

The name of the Line Item, or null when nobody named it.

namestringrequired

The name of the Campaign Plan.

slugstringrequired

The handle of the Campaign Plan, for GET /campaign-plans/{slug}.

nextCursorstring

Send this value as cursor to get the next page. It is absent on the last page.

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed. Or AdCrunch cannot use the cursor: it cannot read it, or the cursor belongs to a different query. Then error is invalid_cursor. Send the nextCursor of the previous page with no change, or omit cursor to get the first page.

Any of:
object
issuesobject[]required

One entry for each field that does not match.

Show properties
Array of object
instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery
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.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

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

Allowed:invalid_request
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.

object
errorstringrequired

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

Allowed:invalid_cursor
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.

401

No API key, or one that does not resolve. 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.

402

The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.

paywallUrlstring<uri>required

The page where an owner of the organization subscribes. Show it to the person.

errorstringrequired

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

Allowed:organization_unentitled
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 campaign_plan: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

No Creative with that id in the Library of this organization. error is not_found.

errorstringrequired

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

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.

Request
curl -X GET 'https://api.pr-1356.adcrunch.dev/context/creatives/string/campaign-plans?limit=100' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "id": "cpl_4b1d7e",
      "lineItems": [
        {
          "id": "lni_7f3a9c",
          "name": "Prospecting"
        },
        {
          "id": "lni_2c8e51",
          "name": null
        }
      ],
      "name": "Q4 Acquisition",
      "slug": "q4-acquisition"
    }
  ]
}

Was this page helpful?