Probably
Start free
Docs

Get a campaign

get_campaign, in Reads: Any connection or key may call these.

POST
/api/v1/tools/get_campaign

A campaign: its product and length, the leads and hook kinds it tries and its pins, each batch with its segments (each body's format and video) and its coded ads (segment, lead, hook kind, format, the hook its opening is written in, its video and line, and where it stands); each ad's results with rates and 95% intervals, once imported; and the learnings they propose, each with what the member decided. Put each ad's code in its ad name in Ads Manager, so import_ad_results matches it.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (prb_…) from Settings → Connections.

Request Body

application/json
  1. body
campaignId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The tool's answer.

application/json
  1. response
campaignId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
spaceId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
status*string
Value in"planning""making""live""ended"
product*
lengthSeconds*integer
Range-9007199254740991 <= value <= 9007199254740991
sourceVideoId*|

The delivered video it tests on its segments, if any

leads*array<>|

The leads its rounds try; null for the two each segment's awareness calls for

hookKinds*array<>|

The hook kinds its rounds try; null for all of them

pins*array<>

What its rounds must hold, first in each segment's ads

batches*array<>
results*array<>
learnings*
curl -X POST 'https://studio.probably.co/api/v1/tools/get_campaign' \  -H "Authorization: Bearer $PROBABLY_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf"}'
{  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",  "spaceId": "a330a273-e64a-4183-aedb-f3152797a9a5",  "name": "string",  "status": "planning",  "product": {    "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f",    "name": "string"  },  "lengthSeconds": -9007199254740991,  "sourceVideoId": "dfb43dd6-0439-4142-90d6-8ee56905929f",  "leads": [    "story"  ],  "hookKinds": [    "problem-callout"  ],  "pins": [    {      "segmentRecordId": "7c9e4c93-9d9c-4ce1-9332-2ecfa0336ccf",      "lead": "story",      "hookKind": "problem-callout"    }  ],  "batches": [    {      "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",      "sequence": -9007199254740991,      "status": "planning",      "segments": [        {          "segmentRecordId": "7c9e4c93-9d9c-4ce1-9332-2ecfa0336ccf",          "name": "string",          "format": "testimonial",          "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",          "bodyDelivered": true        }      ],      "ads": [        {          "adId": "4d241bcb-6046-42ff-be75-7b01bde3898e",          "code": "string",          "segmentRecordId": "7c9e4c93-9d9c-4ce1-9332-2ecfa0336ccf",          "lead": "story",          "hookKind": "question",          "format": "talking-head-ugc",          "hook": {            "kind": "formula",            "formula": "string",            "example": "string"          },          "role": "body",          "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",          "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf",          "progress": "planned"        }      ]    }  ],  "results": [    {      "adId": "4d241bcb-6046-42ff-be75-7b01bde3898e",      "code": "string",      "days": -9007199254740991,      "impressions": -9007199254740991,      "spendCents": -9007199254740991,      "measured": true,      "hookRate": {        "rate": 0,        "low": 0,        "high": 0      },      "holdRate": {        "rate": 0,        "low": 0,        "high": 0      },      "clickRate": {        "rate": 0,        "low": 0,        "high": 0      },      "costPerPurchase": {        "cents": -9007199254740991,        "low": -9007199254740991,        "high": -9007199254740991      }    }  ],  "learnings": {    "proposed": [      {        "key": "string",        "tag": "segment",        "metric": "hookRate",        "winner": {          "value": "string",          "ads": -9007199254740991,          "impressions": -9007199254740991,          "rate": 0,          "low": 0,          "high": 0        },        "loser": {          "value": "string",          "ads": -9007199254740991,          "impressions": -9007199254740991,          "rate": 0,          "low": 0,          "high": 0        },        "sentence": "string",        "decision": "saved"      }    ],    "saved": [      {        "key": "string",        "tag": "segment",        "metric": "hookRate",        "winner": {          "value": "string",          "ads": -9007199254740991,          "impressions": -9007199254740991,          "rate": 0,          "low": 0,          "high": 0        },        "loser": {          "value": "string",          "ads": -9007199254740991,          "impressions": -9007199254740991,          "rate": 0,          "low": 0,          "high": 0        },        "sentence": "string",        "decision": "saved"      }    ]  }}