Documentation Index

Fetch the complete documentation index at: https://support.jacquard.com/llms.txt

Use this file to discover all available pages before exploring further.

Show campaign information

Prev Next
Get
/v2/campaigns/{campaignid}

Returns specified campaign information

Security
HTTP
Type bearer
Header parameters
Accept
string
Exampleapplication/json
Path parameters
campaignid
stringRequired

(Required) Campaign ID

Examplead Ut
Query parameters
allChildren
boolean

Includes all language variants along with the campaign information

Examplefalse
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
{
  "campaign_id": "59807ed854b8891947e04303",
  "project_id": "58fde6419cad0a03e578fe0c",
  "name": "Batmobiles Daily Deals",
  "distribution_channel": "email/push/facebook/sms",
  "testing_methodology": "broadcast/convergence",
  "language_source": "NLG/managed",
  "tracked_metrics": [
    "delivered/opened/clicked",
    "delivered/opened/clicked"
  ],
  "baseline_open_rate": 1.23,
  "created_date_time": "2016-03-15T06:08:27.928Z",
  "last_updated": "2016-03-15T06:08:27.928Z",
  "test_send_date": "2016-03-15",
  "final_send_date": "2016-03-15",
  "audience_size": 12300332,
  "number_of_splits": 10,
  "split_size": 123000,
  "number_of_recipients": 10000000,
  "final_number_of_unsubs": 452,
  "final_unsub_rate": 55.5,
  "final_unique_opens": 56,
  "final_unique_open_rate": 8.41,
  "final_unique_clicks": 55,
  "final_unique_click_rate": 8.26,
  "final_revenue": 5568.21,
  "final_number_of_conversions": 302,
  "variants": [
    {
      "language_variant_id": "5c07e39e477ca9289615b441",
      "campaign_id": "59807ed854b8891947e04303",
      "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
      "project_id": "59807ed854b8891947e04303",
      "created_date_time": "2016-03-15T06:08:27.928Z",
      "last_updated": "2016-03-15T06:08:27.928Z",
      "variant_sent_time": "2016-03-15T06:08:27.928Z",
      "results_at": "2016-03-15T06:08:27.928Z",
      "is_user_language_variant": false,
      "number_of_recipients": 666,
      "number_of_unsubs": 452,
      "unsub_rate": 55,
      "unique_opens": 56,
      "unique_open_rate": 8.41,
      "unique_clicks": 55,
      "unique_click_rate": 8.26,
      "is_winning_line": false,
      "status": "live"
    },
    {
      "language_variant_id": "5c07e39e477ca9289615b441",
      "campaign_id": "59807ed854b8891947e04303",
      "text": "We thought you'd like this... You can check these Batmobiles off your wish list!",
      "project_id": "59807ed854b8891947e04303",
      "created_date_time": "2016-03-15T06:08:27.928Z",
      "last_updated": "2016-03-15T06:08:27.928Z",
      "variant_sent_time": "2016-03-15T06:08:27.928Z",
      "results_at": "2016-03-15T06:08:27.928Z",
      "is_user_language_variant": false,
      "number_of_recipients": 666,
      "number_of_unsubs": 452,
      "unsub_rate": 55,
      "unique_opens": 56,
      "unique_open_rate": 8.41,
      "unique_clicks": 55,
      "unique_click_rate": 8.26,
      "is_winning_line": false,
      "status": "live"
    }
  ]
}
object
401

Unauthorized

""
string
403

Forbidden

""
string