Input Phrasee X results

Prev Next
Post
/results/campaigns/{campaign_id}

Insert results for a Phrasee X campaign that is in progress. These results are submitted per batch, and per variant. Currently we accept data on opens, clicks, and unsubs. These results are AGGREGATED results intended to be submitted on a batched basis, even if the language source is the realtime API. This is a complimentary results input method to our tracking pixel and can be used in conjunction with that.

Security
HTTP
Type bearer

User or account level token in Header, key = 'Authorization', value = 'Bearer '

Path parameters
campaign_id
stringRequired

Campaign Id

Query parameters
format
string

indicates the format of the results being submitted, use acs for adobe campaigns

Valid values[ "acs" ]
Body parameters

Batch results to send to the API

Expand All
OneOf
AdobeCampaignStandardBody
object (AdobeCampaignStandardBody)
data
Array of object (BatchResultKeys)

The key value pair array that will be send to the API

object
language_variant_id
string Required
Example5e37f878f9762374ce288fb8
number_of_recipients
number
Example5
unique_clicks
number
Example3
unique_opens
number
Example2
in_test
boolean
Defaulttrue
ExampleTrue
is_winner
boolean
Defaultfalse
ExampleTrue
estimated_opens
number
Example1
estimated_open_rate
number
Example2
phrasee_score
number
Example1
phrasee_score_rate
number
Example2
clicks_to_opens
number
Example1
clicks_to_sends
number
Example2
unsubscribes
number
Example1
direct_opens
number
Example2
influenced_opens
number
Example1
conversions
number
Example2
revenue
number
Example1
array
array
object

this contains the result information for a batch at correct at the time of submission, this does not have to be the 'final' results for a batch, simply the most accurate results at the time

batch_id
integer

the ID of the batch that these variants are part of

Example10
time_sent
string (date-time)

the time in UTC that the batch was sent out

Example2021-01-30T08:30:00Z
language_variant_results
Array of object (RealtimeVariantResult)

the individual variant result information

object
language_variant_id
string

the internal Phrasee variant ID, this is needed if aggregated results are returned to Phrasee

Example60784abafb1c010008ab79c0
number_of_recipients
integer

the number of recipients of this variant in this batch

Example25328
number_of_opens
integer

the number of opens for this variant in this batch

Example12334
number_of_clicks
integer

the number of clicks for this variant in this batch

Example6584
number_of_unsubs
integer

the number of unsubscriptions for this variant in this batch

Example342
Responses
200

Connect information successfully submitted

401

Invalid token

404

Could not find campaign