Get
/campaigns/{campaignid}
Returns specified campaign information
Security
HTTP
Type bearer
User or account level token in Header, key = 'Authorization', value = 'Bearer '
Path parameters
campaignid
stringRequired
Campaign ID
Query parameters
allChildren
boolean
Includes all language variants along with the campaign information
Defaultfalse
Responses
200
Campaign information returned successfully
object
campaign_id
string
Example59807ed854b8891947e04303
project_id
string
Example58fde6419cad0a03e578fe0c
name
string
ExampleBatmobiles Daily Deals
distribution_channel
string
Exampleemail/push/facebook/sms
testing_methodology
string
Examplebroadcast/convergence
language_source
string
ExampleNLG/managed
tracked_metrics
Array of string
string
Exampledelivered/opened/clicked
baseline_open_rate
number
Example1.23
created_date_time
string (date-time)
Example2016-03-15T06:08:27.928Z
last_updated
string (date-time)
Example2016-03-15T06:08:27.928Z
test_send_date
string (date)
Example2016-03-15
final_send_date
string (date)
Example2016-03-15
audience_size
integer
Example12300332
number_of_splits
integer
Example10
split_size
integer
Example123000
number_of_recipients
integer
number of messages sent
Example10000000
final_number_of_unsubs
integer
Example452
final_unsub_rate
number
Example55.5
final_unique_opens
integer
Example56
final_unique_open_rate
number
Example8.41
final_unique_clicks
integer
Example55
final_unique_click_rate
number
Example8.26
final_revenue
number
Example5568.21
final_number_of_conversions
integer
Example302
variants
Array of object (Variant)
object
language_variant_id
string
Example5c07e39e477ca9289615b441
campaign_id
string
Example59807ed854b8891947e04303
project_id
string
Example59807ed854b8891947e04303
created_date_time
string (date-time)
Example2016-03-15T06:08:27.928Z
last_updated
string (date-time)
Example2016-03-15T06:08:27.928Z
variant_sent_time
string (date-time)
Example2016-03-15T06:08:27.928Z
results_at
string (date-time)
Example2016-03-15T06:08:27.928Z
is_user_language_variant
boolean
ExampleFalse
text
string
ExampleWe thought you'd like this... You can check these Batmobiles off your wish list!
number_of_recipients
number
number of messages sent
Example666
number_of_unsubs
number
Example452
unsub_rate
number
Example55
unique_opens
number
Example56
unique_open_rate
number
Example8.41
unique_clicks
number
Example55
unique_click_rate
number
Example8.26
is_winning_line
boolean
ExampleFalse
status
string
Examplelive
401
Invalid token
403
Supplied token invalid for requested campaign