Acquia Lift Decision API (v2)

Download OpenAPI specification:Download

Interface to be able to capture user behaviours and make decisions based on it.

Authentication

HmacAuthorization

Security Scheme Type	API Key
Header parameter name:	Authorization

HmacAuthorizationTimestamp

Security Scheme Type	API Key
Header parameter name:	X-Authorization-Timestamp

HmacAuthorizationContentSHA256

Security Scheme Type	API Key
Header parameter name:	X-Authorization-Content-SHA256

HmacAuthenticatedId

Security Scheme Type	API Key
Header parameter name:	X-Authenticated-Id

Accounts

GetAccounts

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "account-id-1",
"name": "account-name-1",
"description": "This an an example account description",
"nextGenPerz": false,
"license_id": 1
},
{"id": "account-id-2",
"name": "account-name-2",
"nextGenPerz": false,
"license_id": 2
},
{"id": "account-id-3",
"name": "account-name-3",
"nextGenPerz": true,
"description": "This an an example account description"
},
{"id": "account-id-4",
"name": "account-name-4",
"nextGenPerz": false
}
]

Campaigns

GetCampaignAnalytics

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

campaign_id

string <uuid>

The identifier of the campaign.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.
date_start	string <date> The date of start.
date_end	string <date> The date of end.
details	boolean Requested a detailed response.
nocache	boolean Do we want to receive cached result or not?

Responses

Response samples

200
400
404
500

Content type

application/json

{"campaign_id": "campaign-1",
"campaign_type": "ab",
"times_shown_count": 60,
"click_throughs_count": 25,
"click_through_rate_percentage": 41.7,
"goals_count": 2,
"conversion_rate_percentage": 3.4,
"unique_visitor_count": 100,
"last_updated": "2019-10-09 14:00:00.000UTC",
"rule_id": "rule-1",
"details": {"variations": [{"variation_name": "Original Website",
"variation_id": "default",
"times_shown_count": 20,
"click_throughs_count": 5,
"click_through_rate_percentage": 25,
"goals_count": 17,
"conversion_rate_percentage": 85,
"clickthrough": {"lift_percentage": 10,
"confidence_level": 90,
"significance": "SIGNIFICANTLY_BETTER",
"winner": true
},
"goals": {"lift_percentage": 20,
"confidence_level": 91,
"significance": "SIGNIFICANTLY_BETTER",
"winner": false
}
},
{"variation_name": "Variation #1",
"variation_id": "42ead61e50734a6c9af75",
"times_shown_count": 26,
"click_throughs_count": 23,
"click_through_rate_percentage": 88.4,
"goals_count": 21,
"conversion_rate_percentage": 80.8,
"clickthrough": {"lift_percentage": -23.1,
"confidence_level": 99,
"significance": "SIGNIFICANTLY_WORSE",
"winner": true
},
"goals": {"lift_percentage": 13.1,
"confidence_level": 100,
"significance": "SIGNIFICANTLY_BETTER",
"winner": false
}
}
]
}
}

GetCampaigns

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.
start	integer Default: 0 Where to start from. Eg if you have 20 items, and you fill in 10 as your start number, it will give you all the items from 10 till 19 if the amount of items you request is 10.
rows	integer Default: 10 Amount of items to return.
status	string Enum: "unpublished" "scheduled" "published" "completed" "archived" Filter by the status of campaigns.
type	string Enum: "mixed" "target" "ab" "dynamic" Filter by the type of campaigns.
label	string Filter by the label of campaigns.
sort_field	string Enum: "created" "updated" "start_at" "end_at" "status" "label" Campaign characteristic to sort by.
sort	string Enum: "asc" "desc" Sorting order. Can be 'asc' or 'desc'.
include_rule_and_goal_ids	boolean Optional parameter to specify whether or not to return the Rule Id and Goal Id arrays associated with the campaign being returned. True includes them in the campaign object. False returns a campaign object without the arrays included.
time_filters	string Example: time_filters=/campaigns?time_filters=[{ "field": "created", "operator":">", "value":"2018-09-01T00:00:00Z"}, { "field": "created", "operator":"<=", "value":"2018-09-30T23:59:59Z"}] A string formatted array of time related condition objects which allow the user to filter the returned campaigns based on start_at, end_at, created, and updated times. Users may pass multiple objects for each field to narrow down searches. For example, saying created > Sept 1 and created <= Sept 30 as 2 separate filter objects would return all campaigns created in the month of September.

Responses

Response samples

200
401
500

Content type

application/json

{"total_count": 3,
"campaigns": [{"id": "campaign-1",
"label": "campaign-1",
"site_id": "site-id-1",
"description": "I'm going to create a campaign targeted at pets.",
"type": "mixed",
"status": "unpublished",
"etag": "campaign-1-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-12-10T16:08:12.880Z",
"rule_ids": ["rule-1"
],
"goal_ids": ["goal-1",
"goal-2"
]
},
{"id": "campaign-2",
"label": "campaign-2",
"site_id": "site-id-1",
"description": "Some description about the campaign",
"type": "target",
"status": "published",
"etag": "campaign-2-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-11-10T16:08:12.880Z",
"rule_ids": ["rule-1",
"rule-2"
]
},
{"id": "campaign-3",
"label": "campaign-3",
"site_id": "site-id-2",
"description": "I'm going to create a campaign targeted at pets.",
"type": "ab",
"status": "unpublished",
"etag": "campaign-3-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-12-10T16:08:12.880Z",
"auto_promote": false,
"confidence_level": 90,
"abmetric": "goals"
}
]
}

CreateCampaign

Create or update a campaign

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a campaign object.

id required	string campaign id
site_id required	string The id of the site creating the campaign
label required	string [ 1 .. 255 ] characters Label applied to a campaign
description	string <= 64000 characters
type required	string Default: "mixed" Enum: "mixed" "target" "ab" "recommendation" Type of rules the campaign contains. Possible values are mixed (default), target, ab, recommendation.
status required	string Default: "unpublished" Enum: "unpublished" "scheduled" "published" "completed" "archived" The status of the campaign.
etag	string The entity tag that is created and managed by the server. When a campaign is being updated, the etag retrieved during the GET must be included in the POST.
auto_promote	boolean Flag to enable/disable auto promotion for AB type campaigns
confidence_level	integer [ 0 .. 100 ] The threshold for which the ab campaign should be promoted to target campaign. It is an integer value between 0 and 100.
abmetric	string Enum: "goals" "clickthroughs" Type of metric for auto-promote settings.
start_at	string <date-time> time the campaign starts after publishing
end_at	string <date-time> time the campaign ends after publishing
rule_ids	Array of strings Rule ids associated with the campaign.
goal_ids	Array of strings Goal ids associated with the campaign.

Responses

Request samples

Payload

Content type

application/json

Example

{"id": "campaign-1",
"label": "campaign-1",
"site_id": "site-id-1",
"description": "I'm going to create a campaign targeted at pets.",
"type": "mixed",
"status": "unpublished",
"etag": "campaign-1-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-12-10T16:08:12.880Z",
"rule_ids": ["rule-1",
"rule-3",
"rule-9"
],
"goal_ids": ["goal-1",
"goal-3"
]
}

Response samples

200
401
500

Content type

application/json

Example

{"id": "campaign-1",
"label": "campaign-1",
"site_id": "site-id-1",
"description": "I'm going to create a campaign targeted at pets.",
"type": "mixed",
"status": "unpublished",
"etag": "campaign-1-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-12-10T16:08:12.880Z",
"rule_ids": ["rule-1",
"rule-3",
"rule-9"
],
"goal_ids": ["goal-1",
"goal-3"
]
}

DeleteCampaigns

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

401
500

Content type

application/json

{"error": "Could not extract account_id."
}

GetCampaign

Get an individual campaign

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

campaign_id

required

string <uuid>

The identifier of the campaign.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
401
500

Content type

application/json

Example

{"id": "campaign-1",
"label": "campaign-1",
"site_id": "site-id-1",
"description": "I'm going to create a campaign targeted at pets.",
"type": "mixed",
"status": "unpublished",
"etag": "campaign-1-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-12-10T16:08:12.880Z",
"rule_ids": ["rule-1"
],
"goal_ids": ["goal-1",
"goal-2"
]
}

UpdateCampaign

Update specific fields of a campaign

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

campaign_id

required

string <uuid>

The identifier of the campaign.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Request Body schema: application/json

Update a singular characteristic of a Campaign through the PATCH endpoint. Currently the endpoint only supports updating status (except scheduled), type (to mixed only), description, and label.

label	string [ 1 .. 255 ] characters Label applied to a campaign
description	string <= 64000 characters Description of the campaign.
type	string Value: "mixed" Type of the campaign. Can only be changed to a mixed campaign through PATCH endpoint.
status	string Enum: "unpublished" "published" "completed" "archived" The status of the campaign. Must be a valid status change as mirrored in POST endpoint.
auto_promote	boolean Flag to enable/disable auto promotion for AB type campaigns
confidence_level	integer [ 0 .. 100 ] The threshold for which the ab campaign should be promoted to target campaign. It is an integer value between 0 and 100.
abmetric	string Enum: "goals" "clickthroughs" Type of metric for auto-promote settings.

Responses

Request samples

Payload

Content type

application/json

Example

{"label": "effective_campaign_1",
"description": "New Campaign",
"status": "unpublished",
"type": "mixed"
}

Response samples

200
400
401
500

Content type

application/json

Example

{"id": "campaign-1",
"label": "campaign-1",
"site_id": "site-id-1",
"description": "I'm going to create a campaign targeted at pets.",
"type": "mixed",
"status": "unpublished",
"etag": "campaign-1-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2018-12-10T16:08:12.880Z",
"rule_ids": ["rule-1",
"rule-3",
"rule-9"
],
"goal_ids": ["goal-1",
"goal-3"
]
}

DeleteCampaign

Delete a campaign using the campaign id.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

campaign_id

required

string <uuid>

The identifier of the campaign.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

401
500

Content type

application/json

{"error": "Could not extract account_id."
}

CloneCampaign

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

campaign_id

required

string <uuid>

The identifier of the campaign.

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
404
500

Content type

application/json

{"id": "campaign-2",
"label": "[COPY] - campaign-1",
"site_id": "site-id-1",
"description": "I'm going to create a campaign targeted at pets.",
"type": "mixed",
"status": "published",
"etag": "campaign-2-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2022-12-10T16:08:12.880Z",
"rule_ids": ["rule-2"
],
"goal_ids": ["goal-1",
"goal-2"
]
}

PromoteVariation

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

campaign_id

required

string <uuid>

The identifier of the campaign.

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a variation id.

variation_id

string [ 1 .. 255 ] characters

Id of the variation that we want to promote to a standalone target campaign.

Responses

Request samples

Payload

Content type

application/json

{"variation_id": "variation-id-1"
}

Response samples

200
401
404
500

Content type

application/json

{"id": "new-target-campaign",
"label": "Promoted from old-campaign-label",
"site_id": "site-id-1",
"description": "Promoted from old-campaign-label",
"type": "target",
"status": "unpublished",
"etag": "new-target-campaign-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": "2018-09-10T16:08:12.880Z",
"end_at": "2022-12-10T16:08:12.880Z",
"rule_ids": ["new-target-rule"
],
"goal_ids": ["goal-1",
"goal-2"
]
}

MergeCampaigns

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

List of campaign ids.

Array ()

string unique

Responses

Request samples

Payload

Content type

application/json

["example-campaign-id-1",
"example-campaign-id-2",
"example-campaign-id-3",
"example-campaign-id-4"
]

Response samples

200
401
404
500

Content type

application/json

{"id": "campaign-2",
"label": "campaign-1-merged",
"site_id": "site-id-1",
"description": "campaign-1 description",
"type": "mixed",
"status": "unpublished",
"etag": "campaign-2-etag",
"created": "2018-09-10T16:08:12.880Z",
"updated": "2018-09-10T16:08:12.880Z",
"start_at": null,
"end_at": null,
"rule_ids": ["rule-2"
],
"goal_ids": ["goal-1",
"goal-2"
]
}

Capture

GetCaptures

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
prefetch	boolean Default: false Example: prefetch=true Some requests can be requested to go and get the HTML of the content item they show. Eg. /search or /content.
tid	string touch_identifier, Internal identifier for the touch, if this field is left empty, lift will generate a touch identifier and include it in the response
ident	string identity, Visitor's primary identity information.
identsrc	string identity_source, Type of visitor's primary identity information. Specific string (account, email, facebook, twitter, tracking, name) or custom identifier type.
en	string event_name, Event name corresponding to the captured information - the event type matching this event name must match the master list of events created in Acquia Lift Profile Manager
es	string event_source, Source of the event - can be used to pass event data from tools you have set up to send data to Acquia Lift Profile Manager (the default Acquia Lift Profile Manager value is web; depending on your website's configuration, examples may include csrtool1 and promo1)
ed	string <date-time> event_date, Date of the Event. Timestamp in ISO 8601 format, YYYY-MM-DDTHH:MM:SSZ
ids	string identities, Additional identity information, can be included multiple times. The value is a concatenation of the identity and its source, separated by a "\|" (examples include "john.smith@acquia.com\|email" and "John Smith\|name"})
url	string <= 2000 characters url, The URL on which the event was triggered.,
rurl	string <= 4000 characters referral_url, Referrer's URL
cttl	string <= 200 characters content_title, Page title
ua	string <= 2000 characters user_agent, Visitor's user agent
pltfrm	string <= 50 characters platform, Visitor's platform
ip	string <= 45 characters ip_address, Visitor's IP address (supports both IPv4 and IPv6 addresses)
p	string <= 1000 characters persona, User-defined category into which a visitor fits, based on their viewing of particular content
escore	integer engagement_score, The number that you have chosen to signify the importance of a visitor's interest in an event
pn	string <= 1000 characters personalization_name, (DEPRECATED) Name of personalization associated with an event
pmn	string <= 1000 characters personalization_machine_name, (DEPRECATED) Machine name of personalization associated with an event
pcv	string <= 1000 characters personalization_chosen_variation, (DEPRECATED) The variation (decision) chosen for an event
pdp	string <= 1000 characters personalization_audience_name, (DEPRECATED) The name of the audience
pan	string <= 1000 characters personalization_decision_policy, (DEPRECATED) The decision policy used - for example, explore or target
pgn	string <= 1000 characters personalization_goal_name, (DEPRECATED) The name of the goal reached
pgv	string <= 1000 characters personalization_goal_value, (DEPRECATED) The value of the goal reached
dsid	string <= 1000 characters decision_slot_id, The id of the slot for which a decision was made
dsid	string <= 1000 characters decision_slot_name, The name of the slot for which a decision was made
dsn	string <= 1000 characters decision_slot_name, The name of the slot for which a decision was made
drid	string <= 1000 characters decision_rule_id, The id of the rule that was used to make a decision
drn	string <= 1000 characters decision_rule_name, The name of the rule that was used to make a decision
drt	string <= 1000 characters decision_rule_type, The type of the rule that was used to make a decision
drsid	string <= 1000 characters decision_rule_segment_id, The id of the rule segment that was used to make a decision
drsn	string <= 1000 characters decision_rule_segment_name, The name of the rule segment that was used to make a decision
dcid	string <= 1000 characters decision_content_id, The id of the content that was returned in the decision
dcn	string <= 1000 characters decision_content_name, The name of the content that was returned in the decision
dgid	string <= 1000 characters decision_goal_id, The id of the goal that was triggered by the decision
dgn	string <= 1000 characters decision_goal_name, The name of the goal that was triggered by the decision
dgv	string <= 1000 characters decision_goal_value, The value of the goal that was triggered by the decision
dvm	string <= 1000 characters decision_view_mode, The viewmode of the content that was returned in the decision
dp	string <= 1000 characters decision_policy, The policy that was used to make the decision (explore,exploit,repeat)
capid	string <= 22 characters capture_identifier, Unique identifier for the capture
ctz	string <= 100 characters client_timezone, Client time zone
jsv	string <= 10 characters javascript_version, version of the javascript that generated the capture
pid	string <= 22 characters post_id, post id of an article
cid	string <= 22 characters content_id, content id of an article
cuuid	string <= 1000 characters content_uuid, content uuid of an article
ctype	string <= 200 characters content_type, Content-type to which a piece of visitor-viewed content belongs
csec	string <= 1000 characters content_section, content section of an article
ckw	string <= 1000 characters content keywords of an article
author	string <= 1000 characters content_keywords, author of an article
pt	string <= 200 characters page_type, Category of page the visitor viewed (examples include article page, tag page, and home page)
pd	string <date-time> published_date, Publish date of an article. Timestamp in ISO 8601 format, YYYY-MM-DDTHH:MM:SSZ
dcpid	string Unique ID of the rule's campaign.
dcpn	string Name of the rule's campaign.
dcpt	string Type of the rule's campaign.
drvid	string Id of the AB test rule's chosen variation.
drvn	string Label of the AB test rule's chosen variation.
dnt	boolean Flag to indicate whether the person should not be tracked.
pu([1-9]\|[1-4][0-9]\|50)	string person_udfXX, Custom fields for person information
eu([1-9]\|[1-4][0-9]\|50)	string event_udfXX, Custom fields for event information
tu([1-9]\|1[0-9]\|20)	string touch_udfXX, Custom fields for touch information

Responses

Response samples

200
400
500

Content type

application/json

{"touch_identifier": "fM2RzZmdhNHczIDVxMjM=",
"identity": "vDS4dc29tZWlkZW50aWZlcg",
"identity_source": "tracking",
"matched_segments": [{"id": "10092",
"name": "Anonymous Visitor",
"description": "Tracks whether a visitor to the site is anonymous"
},
{"id": "10096",
"name": "Interested Visitor",
"description": "If the new user clicks on the about us section of the site, then they are an interested visitor learning more about the service."
}
]
}

CreateCaptures

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
prefetch	boolean Default: false Example: prefetch=true Some requests can be requested to go and get the HTML of the content item they show. Eg. /search or /content.

Request Body schema: application/json

Capture events without making a decision

touch_identifier	string <= 22 characters Internal identifier for the touch, if this field is left empty, lift will generate a touch identifier and include it in the response
identity	string <= 200 characters Visitor's primary identity information.
identity_source	string <= 200 characters Type of visitor's primary identity information. Specific string (account, email, facebook, twitter, tracking, name) or custom identifier type.
do_not_track	boolean Default: false Flag to indicate whether the person should not be tracked.
return_segments	boolean Default: false Flag to indicate whether the response should include matched segment information.
return_content_views	boolean Default: false Flag to indicate whether the response should include content UUIDs that were viewed previously by the visitor.
site_id	string <= 20 characters The customer site matching external_site_id in the configuration database. Used for filtering segments to evaluate and the default site_id for captures. If not specified then the last capture is used to calculate the site_id for filtering segments.
	Array of Array of objects (Capture) List of captures.

Responses

Request samples

Payload

Content type

application/json

{"touch_identifier": "eGlhb2dlbGFpd2FuYQ==",
"identity": "test@example.com",
"identity_source": "email",
"do_not_track": false,
"return_segments": true,
"return_content_views": false,
"site_id": "MySiteId",
"captures": [{"event_name": "Content View",
"event_source": "web",
"event_date": "2016-01-22 10:20:21:1",
"identities": {"dG9vTG9uZyB0byBkZWNvZGUNCg==": "tracking",
"lift customer": "name"
},
"person_udf50": "c3RvcHRyeWluZw=="
},
{"event_name": "Content View",
"event_source": "web",
"event_date": "2016-01-22 10:20:31:1",
"identities": {"test2@example.com": "email",
"lift customer": "name"
},
"engagment_score": 50,
"person_udf50": "aWxpa2V5b3VyaGF0"
}
]
}

Response samples

200
400
500

Content type

application/json

{"touch_identifier": "fM2RzZmdhNHczIDVxMjM=",
"identity": "vDS4dc29tZWlkZW50aWZlcg",
"identity_source": "tracking",
"matched_segments": [{"id": "10092",
"name": "Anonymous Visitor",
"description": "Tracks whether a visitor to the site is anonymous"
},
{"id": "10096",
"name": "Interested Visitor",
"description": "If the new user clicks on the about us section of the site, then they are an interested visitor learning more about the service."
}
]
}

GetCaptureConfig

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200

Content type

application/json

{"activity_level": "FULL",
"tracking_time": 63072000,
"third_party_cookie_enabled": false,
"first_party_cookie_base_domain_enabled": true,
"max_queue_cookie_size": 4093
}

Content

GetContents

Get list of content with pagination.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
prefetch	boolean Default: false Example: prefetch=true Some requests can be requested to go and get the HTML of the content item they show. Eg. /search or /content.
start	integer Default: 0 Where to start from. Eg if you have 20 items, and you fill in 10 as your start number, it will give you all the items from 10 till 19 if the amount of items you request is 10.
rows	integer Default: 10 Amount of items to return.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
context_language	string Example: context_language=fr REQUIRED if passing cdf_version=2. The 2 or 4 letter language code of the desired piece of content.
include_origin_and_tags	boolean Default: false Example: include_origin_and_tags=true Flag to return back origin and tag ids and labels. Default is set to false.
q	string The keyword(s) to find, space delimited
nocache	boolean Do we want to receive cached result or not?
view_mode	string REQUIRED if passing cdf_version=2.
all_tags	boolean Flag used for tag operator when querying results. Default value is false which implies that the 'OR' operation would be used.
sort	string Default: "score" Sorting field options - true for ascending, false for descending. Default is score.
content_type	string Filter on content with any of the specified content types. Multiple values are possible.
origins	string Filter on content coming from any of the specified origins. Multiple values are possible.
tags	string Filter on content with all of the specified tags. Multiple values are possible.
date_start	string <date> Filter on content modified after this date. Format dd-mm-yyyy or now-d/d. See the elasticsearch docs for more info on date math.
date_end	string <date> Filter on content modified before this date. Format dd-mm-yyyy or now-d/d. See the elasticsearch docs for more info on date math.
date_timezone	string <date> The timezone offset for the date range. Format +/- (e.g., -04:00)

Responses

Response samples

200
400
401
500

Content type

application/json

{"total_count": 2,
"contents": [{"title": "Front Banner 1",
"id": "front-banner-1",
"content_connector_id": "nicks_content_hub_identifier",
"created": "2015-11-28T17:17:34.200Z",
"updated": "2016-01-05T08:44:31.952Z",
"base_url": "http://nickveenhof.be",
"origin": {"id": "93da00ef-7ea1-400d-8269-f9084224e369",
"label": "lift-decision-api"
},
"tags": [{"id": "884011b3-54ae-4fd3-b3a6-93095949eda9",
"label": "tag-1"
},
{"id": "21ce26e8-b4a7-408d-94cd-02c2400a7ed1",
"label": "tag-2"
}
],
"view_modes": [{"id": "banner-wide",
"language": "en",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-wide-1.png",
"url": "http://nickveenhof.be/liftv3/render/front-banner-1/banner-wide",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-wide-something-something-1.png\"/>"
},
{"id": "banner-small",
"language": "en",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-small-1.png",
"url": "http://nickveenhof.be/liftv3/render/front-banner-1/banner-small",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-small-something-something-1.png\"/>"
}
]
},
{"title": "Front Banner 2",
"id": "front-banner-2",
"content_connector_id": "nicks_content_hub_identifier",
"created": "2015-11-28T17:17:34.200Z",
"updated": "2016-01-05T08:44:31.952Z",
"base_url": "http://nickveenhof.be",
"origin": {"id": "93da00ef-7ea1-400d-8269-f9084224e369",
"label": "lift-decision-api"
},
"tags": [{"id": "884011b3-54ae-4fd3-b3a6-93095949eda9",
"label": "tag-1"
}
],
"view_modes": [{"id": "banner-wide",
"language": "en",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-wide-1.png",
"url": "http://nickveenhof.be/liftv3/render/front-banner-1/banner-wide",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-wide-something-something-1.png\"/>"
},
{"id": "banner-small",
"language": "en",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-small-1.png",
"url": "http://nickveenhof.be/liftv3/render/front-banner-1/banner-small",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-small-something-something-1.png\"/>"
}
]
}
]
}

CreateContents

Push a list content(s) into content provider.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.

Request Body schema: application/json

List of CDF entities.

One of

resource required	string Resource URL
	object Array list of Entity to be pushed to content collector

Responses

Request samples

Payload

Content type

application/json

Example

"{\n \"resource\" : \"some-url-to-content\"\n}\n"

Response samples

202
400
401
500

Content type

application/json

{"message": "Entity create request is acknowledged."
}

GetContent

Retrieve an individual content.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

content_id

required

string <uuid>

The identifier of the content.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
context_language	string Example: context_language=fr REQUIRED if passing cdf_version=2. The 2 or 4 letter language code of the desired piece of content.
include_origin_and_tags	boolean Default: false Example: include_origin_and_tags=true Flag to return back origin and tag ids and labels. Default is set to false.
origins	string Filter on content coming from any of the specified origins. Multiple values are possible.
nocache	boolean Do we want to receive cached result or not?

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"title": "Front Banner 1",
"id": "front-banner-1",
"content_connector_id": "nicks_content_hub_identifier",
"created": "2015-11-28T17:17:34.200Z",
"updated": "2016-01-05T08:44:31.952Z",
"base_url": "http://nickveenhof.be",
"view_modes": [{"id": "banner-wide",
"language": "en",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-wide-1.png",
"url": "http://nickveenhof.be/liftv3/render/front-banner-1/banner-wide",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-wide-something-something-1.png\"/>"
},
{"id": "banner-small",
"language": "en",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-small-1.png",
"url": "http://nickveenhof.be/liftv3/render/front-banner-1/banner-small",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-small-something-something-1.png\"/>"
}
]
}

UpdateContent

Updates an individual content.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

content_id

required

string <uuid>

The identifier of the content.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.

Request Body schema: application/json

List of CDF entities.

One of

resource required	string Resource URL
	object Array list of Entity to be pushed to content collector

Responses

Request samples

Payload

Content type

application/json

Example

{"resource": "some-url-to-content"
}

Response samples

202
400
401
500

Content type

application/json

{"message": "Entity update request is acknowledged (id 4f66cdee-22dd-446a-95e4-f6c51f209d94)."
}

DeleteContent

Remove an existing content.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

content_id

required

string <uuid>

The identifier of the content.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.

Responses

Response samples

202
400
401
500

Content type

application/json

{"message": "Entity delete request is acknowledged (id 4f66cdee-22dd-446a-95e4-f6c51f209d94)."
}

GetContentMetadata's

Retreive all content metadata belonging to an account.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
400
401
500

Content type

application/json

{"origins": {"27ba5a95-67ad-4e27-6122-b097db008108": "source1",
"dcccef1b-6338-4d61-4d93-c145d1d14b9e": "source2"
},
"tags": {"a6b3a71b-2a25-4c9f-8a10-8419813e81a0": "tag1",
"ec1fbd4b-9b86-4da9-adde-299b2d40339e": "tag2",
"b6ad31ca-e9e3-47e8-b3ab-5c86713e2b7d": "tag3"
}
}

SearchContent

Find content by keyword, origins, tags, content type, and date.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
prefetch	boolean Default: false Example: prefetch=true Some requests can be requested to go and get the HTML of the content item they show. Eg. /search or /content.
start	integer Default: 0 Where to start from. Eg if you have 20 items, and you fill in 10 as your start number, it will give you all the items from 10 till 19 if the amount of items you request is 10.
rows	integer Default: 10 Amount of items to return.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
context_language	string Example: context_language=fr REQUIRED if passing cdf_version=2. The 2 or 4 letter language code of the desired piece of content.
include_origin_and_tags	boolean Default: false Example: include_origin_and_tags=true Flag to return back origin and tag ids and labels. Default is set to false.
q	string The keyword(s) to find, space delimited
nocache	boolean Do we want to receive cached result or not?
all_tags	boolean Flag used for tag operator when querying results. Default value is false which implies that the 'OR' operation would be used.
view_mode	string REQUIRED if passing cdf_version=2.
sort	string Default: "score" Sorting field options - true for ascending, false for descending. Default is score.
content_type	string Filter on content with any of the specified content types. Multiple values are possible.
origins	string Filter on content coming from any of the specified origins. Multiple values are possible.
tags	string Filter on content with all of the specified tags. Multiple values are possible.
date_start	string <date> Filter on content modified after this date. Format dd-mm-yyyy or now-d/d. See the elasticsearch docs for more info on date math.
date_end	string <date> Filter on content modified before this date. Format dd-mm-yyyy or now-d/d. See the elasticsearch docs for more info on date math.
date_timezone	string <date> The timezone offset for the date range. Format +/- (e.g., -04:00)

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "front-banner-1",
"title": "Front Banner 1",
"content_connector_id": "nicks_content_hub_identifier",
"view_modes": [{"id": "banner-wide",
"language": "en",
"label": "Banner Wide",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-wide-1.png",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-wide-something-something-1.png\"/>"
},
{"id": "banner-small",
"language": "en",
"label": "Banner Small",
"preview_image": "http://nickveenhof.be/sites/all/default/files/preview-banner-small-1.png",
"html": "<img src=\"nickveenhof.be/sites/all/files/banner-small-something-something-1.png\"/>"
}
]
},
{"id": "some-banner",
"title": "some banner",
"content_connector_id": "nicks_local_file_identifier",
"view_modes": [{"id": "banner-random",
"language": "en",
"label": "Banner Random",
"preview_image": "localhost/banner-random.png",
"html": "<img src=\"localhost/banner-random.png\"/>"
}
]
}
]

Decide

CreateDecision

Make a decision

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
origins	Array of strings List of origins.
entities	string Indicate that decision api needs to return the full cdf objects too.

Request Body schema: text/plain

Make a decision.

Any of

slots required	Array of strings List of slot UIDs.
url	stringuri The URI for which we are making a decision for so we can fetch all the slots that belong to this URI.
do_not_track	boolean Parameter indicating that the visitor does not want to be tracked.
source	string <uri> The url of the lift.js file from which the request originated. Ignored by the /decide endpoint.
preview	boolean Default: false Parameter indicating the request wants a preview of a decision based on the passed segments, not on actual user data.
preview_rule_id	string The id of the rule that is requested to use for the preview. If it's invalid, an empty decision will be given back.
preview_rule_ab_variation	string The variation id of the ab variation that is requested for the preview. If it's invalid, the default variation will be used (Original Website).
segments	Array of strings The list of segment ids that will be used for making the decision. When not empty, this list will override the actual segment ids computed by Lift Profile Manager.
touch_identifier	string <= 22 characters Internal identifier for the touch, if this field is left empty, lift will generate a touch identifier and include it in the response
identity	string <= 200 characters Visitor's primary identity information. Unique Hash generated by the API if not given.
identity_source	string <= 200 characters Type of visitor's primary identity information. Specific string (account, email, facebook, twitter, tracking, name) or custom identifier type.
identity_expiry	integer Expiry date of identity in Unix time (seconds since 1970)
required	Array of objects (Capture) non-empty unique List of captures.

Responses

Request samples

Payload

Content type

text/plain

{
  "slots": [
    "slot-1",
    "slot-2"
  ],
  "do_not_track": false,
  "touch_identifier": "2YjfTpTyI2Q1hCR0fA57qh",
  "identity": "5TYO36lJUkcmOCwZVOj8Di",
  "identity_source": "tracking",
  "identity_expiry": 1524323730,
  "captures": [
    {
      "event_name": "Content View",
      "event_source": "Web",
      "event_date": "2016-04-23T10:01:00.0Z",
      "url": "www.acquia.com",
      "referrer": "www.drupal.org",
      "title": "Welcome to Acquia",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:41.0) Gecko/20100101 Firefox/41.0",
      "ip_address": "192.168.1.1"
    },
    {
      "event_name": "Content View",
      "event_source": "Web",
      "event_date": "2016-04-23T10:01:01.0Z",
      "url": "www.acquia.com/about",
      "referrer": "www.acquia.com",
      "title": "About Acquia",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:41.0) Gecko/20100101 Firefox/41.0",
      "ip_address": "192.168.1.1"
    }
  ]
}

Response samples

200
400

Content type

application/json

{"identity": {"tc_ptid": "5TYO36lJUkcmOCwZVOj8Di",
"tc_ptidexpiry": 1524323730,
"tc_ttid": "2YjfTpTyI2Q1hCR0fA57qh"
},
"segments": [{"id": "CANADAVISITOR",
"name": "Visitors from Canada",
"description": "All visitors that are browsing from Canada"
},
{"id": "FIRSTTIMEVISITOR",
"name": "New Visitor",
"description": "First time visitors",
"site": ["CORP",
"MAG"
]
}
],
"decisions": {"slot-id-1": {"slot_name": "my slot",
"slot_css_selector": "btn.awesome",
"rule_id": "rule-1",
"rule_name": "My Rule",
"rule_type": "ab",
"policy": "explore"
},
"slot-id-2": {"slot_name": "My second slot",
"slot_css_selector": "btn.more-awesome",
"rule_id": "rule-2",
"rule_name": "My other rule",
"rule_type": "ab",
"policy": "exclude"
}
}
}

MakeDecision

query Parameters

entities

string

Indicate that decision api needs to return the full cdf objects too.

Request Body schema: application/json

Make a decision and return JS specific to Lift 3.

Any of

slots required	Array of strings List of slot UIDs.
url	stringuri The URI for which we are making a decision for so we can fetch all the slots that belong to this URI.
do_not_track	boolean Parameter indicating that the visitor does not want to be tracked.
source	string <uri> The url of the lift.js file from which the request originated. Ignored by the /decide endpoint.
preview	boolean Default: false Parameter indicating the request wants a preview of a decision based on the passed segments, not on actual user data.
preview_rule_id	string The id of the rule that is requested to use for the preview. If it's invalid, an empty decision will be given back.
preview_rule_ab_variation	string The variation id of the ab variation that is requested for the preview. If it's invalid, the default variation will be used (Original Website).
segments	Array of strings The list of segment ids that will be used for making the decision. When not empty, this list will override the actual segment ids computed by Lift Profile Manager.
touch_identifier	string <= 22 characters Internal identifier for the touch, if this field is left empty, lift will generate a touch identifier and include it in the response
identity	string <= 200 characters Visitor's primary identity information. Unique Hash generated by the API if not given.
identity_source	string <= 200 characters Type of visitor's primary identity information. Specific string (account, email, facebook, twitter, tracking, name) or custom identifier type.
identity_expiry	integer Expiry date of identity in Unix time (seconds since 1970)
required	Array of objects (Capture) non-empty unique List of captures.

Responses

Request samples

Payload

Content type

application/json

{"slots": ["slot-1",
"slot-2"
],
"do_not_track": false,
"touch_identifier": "2YjfTpTyI2Q1hCR0fA57qh",
"identity": "5TYO36lJUkcmOCwZVOj8Di",
"identity_source": "tracking",
"identity_expiry": 1524323730,
"captures": [{"event_name": "Content View",
"event_source": "Web",
"event_date": "2016-04-23T10:01:00.0Z",
"url": "www.acquia.com",
"referrer": "www.drupal.org",
"title": "Welcome to Acquia",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:41.0) Gecko/20100101 Firefox/41.0",
"ip_address": "192.168.1.1"
},
{"event_name": "Content View",
"event_source": "Web",
"event_date": "2016-04-23T10:01:01.0Z",
"url": "www.acquia.com/about",
"referrer": "www.acquia.com",
"title": "About Acquia",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:41.0) Gecko/20100101 Firefox/41.0",
"ip_address": "192.168.1.1"
}
]
}

Response samples

200
400

Content type

application/json

{"identity": {"tc_ptid": "5TYO36lJUkcmOCwZVOj8Di",
"tc_ptidexpiry": 1524323730,
"tc_ttid": "2YjfTpTyI2Q1hCR0fA57qh"
},
"segments": [{"id": "CANADAVISITOR",
"name": "Visitors from Canada",
"description": "All visitors that are browsing from Canada"
},
{"id": "FIRSTTIMEVISITOR",
"name": "New Visitor",
"description": "First time visitors",
"site": ["CORP",
"MAG"
]
}
],
"decisions": {"slot-id-1": {"slot_name": "my slot",
"slot_css_selector": "btn.awesome",
"rule_id": "rule-1",
"rule_name": "My Rule",
"rule_type": "ab",
"policy": "explore"
},
"slot-id-2": {"slot_name": "My second slot",
"slot_css_selector": "btn.more-awesome",
"rule_id": "rule-2",
"rule_name": "My other rule",
"rule_type": "ab",
"policy": "exclude"
}
}
}

Sites

DeploySite

Deploy the complete source site to the destination site. If the destination site already exists, the deployment will continue and overwrite the current state of the destination site. This overwrite includes all campaigns and rules currently configured on the destination site.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
source_site_id required	string The id of the source site that will be migrated to the destination site.
dest_site_id required	string The id of the destination site that the source site will be migrated to.

Responses

Response samples

200
401
500

Content type

plain/text

Successfully deployed source_site_id to dest_site_id

GetSites

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
include_site_details	boolean If set to "true", the number of campaigns, slots and pages will be returned in the response. Flag is defaulted to false.

Responses

Response samples

200
401
500

Content type

application/json

Example

[{"id": "site_1",
"name": "Site 1",
"url": "site-1-url"
},
{"id": "site_2",
"name": "Site 2",
"url": "site-2-url"
},
{"id": "site_3",
"name": "Site 3"
}
]

CreateSites

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

Create/Update customer site(s) associated with account id. When POST'ing a site with the same identifier, it will update that existing site.

Array ()

id required	string^[a-z0-9_-]{1,128}$ Id associated with customer site
name required	string Name associated with customer site
url	string Url associated with customer site
campaigns	number Number of active campaigns associated with the site. Archived campaigns will not be included in the total count. This field will appear if include details flag is set to true from request
slots	number Number of slots configured on the site. Slots that have a visbility of hide will not be included in the total count. This field will appear if include details flag is set to true from request
pages	number Number of unique page urls configured in slots associated with site. Pages configured in hidden slots will not be included in the total count. This field will appear if include details flag is set to true from request

Responses

Request samples

Payload

Content type

application/json

[{"id": "site_1",
"name": "Site 1",
"url": "site-1-url"
},
{"id": "site_2",
"name": "Site 2",
"url": "site-2-url"
},
{"id": "site_3",
"name": "Site 3"
}
]

Response samples

200
401
500

Content type

application/json

[{"status": "SUCCESS",
"item": {"id": "site_1",
"name": "Site 1",
"url": "site-1-url"
}
},
{"status": "SUCCESS",
"item": {"id": "site_2",
"name": "Site 2",
"url": "site-2-url"
}
},
{"status": "FAILURE",
"errors": [{"code": "DUPLICATED_NAME",
"message": "Goal with the same name already exists"
},
{"code": "INVALID_SITE_ID",
"message": "Invalid site provided"
}
],
"item": {"id": "site_1",
"name": "Site 1",
"url": "site-1-url"
}
}
]

GetSite

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

site_id

required

string

Unique id of the site.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
include_site_details	boolean If set to "true", the number of campaigns, slots and pages will be returned in the response. Flag is defaulted to false.

Responses

Response samples

200
401
500

Content type

application/json

Example

{"id": "site_1",
"name": "Site 1",
"url": "site-1-url"
}

DeleteSite

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

site_id

required

string

Unique id of the site.

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
500

Content type

application/json

{"message": "The site id has been deleted"
}

Events

GetEvents

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"event_name": "Content View",
"event_id": "Content View",
"event_type": "OTHER",
"id": "Q29udGVudCBWaWV3"
},
{"event_name": "Campaign Action",
"event_id": "Campaign Action",
"event_type": "ACTION",
"id": "Q2FtcGFpZ24gQWN0aW9u"
},
{"event_name": "Campaign Click Through",
"event_id": "Campaign Click Through",
"event_type": "CLICK",
"id": "Q2FtcGFpZ24gQ2xpY2sgVGhyb3VnaA=="
},
{"event_name": "Decision",
"event_id": "Decision",
"event_type": "OTHER",
"id": "RGVjaXNpb24="
},
{"event_name": "Goal",
"event_id": "Goal",
"event_type": "OTHER",
"id": "R29hbA=="
},
{"event_name": "Click-Through",
"event_id": "Click-Through",
"event_type": "OTHER",
"id": "Q2xpY2stVGhyb3VnaA=="
}
]

CreateEvent

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a event post object.

event_name required	string <= 200 characters Human readable name of the event.
event_id required	string <= 200 characters External id of the event.
event_type required	string Type of the event, choose from - ACTION, CLICK, CONVERSION, OTHER
site_id	string External id of the customer site. If not provided, site will be configured as global.

Responses

Request samples

Payload

Content type

application/json

{"event_id": "Test Event Id",
"event_name": "Test Event",
"event_type": "CLICK"
}

Response samples

201
400
401
403
500

Content type

application/json

{"id": "Q29udGVudCBWaWV3",
"event_name": "Content View",
"event_id": "Content View",
"event_type": "OTHER"
}

GetEvent

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

id

required

string <base64>

Base64 encoding of event_id

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "Q29udGVudCBWaWV3",
"event_name": "Content View",
"event_id": "Content View",
"event_type": "OTHER"
}

DeleteEvent

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

id

required

string <base64>

Base64 encoding of event_id

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

400
403
500

Content type

application/json

{"error": "Error in deleting event by id (VGVzdCBFdmVudA==)"
}

UpdateEvent

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

id

required

string <base64>

Base64 encoding of event_id

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a event object.

event_name required	string <= 200 characters Human readable name of the event.
event_type required	string Type of the event, choose from - ACTION, CLICK, CONVERSION, OTHER
site_id	string External id of the customer site. If not provided, site will be configured as global.

Responses

Request samples

Payload

Content type

application/json

{"event_name": "Test Event",
"event_type": "CLICK"
}

Response samples

400
401
403
500

Content type

application/json

{"error": "Failed to contact liftweb (code: 400): ''event_name', or 'event_type' is not present'."
}

Filter

GetFilters

Returns a list of filters that belong to that client.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
start	integer Default: 0 Where to start from. Eg if you have 20 items, and you fill in 10 as your start number, it will give you all the items from 10 till 19 if the amount of items you request is 10.
rows	integer Default: 10 Amount of items to return.

Responses

Response samples

200
400
401
500

Content type

application/json

[{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
},
{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
}
]

CreateFilter

This method will save/update an individual filter.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Request Body schema: application/json

Filter entity object.

uuid required	string^[a-z0-9_-]{1,128}$ Filter UUID.
name required	string^[a-z0-9_-]{1,128}$ Filter Name.
required	object Filter parameters specifying the search query terms.

Responses

Request samples

Payload

Content type

application/json

{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
}

Response samples

201
400
401
500

Content type

application/json

{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
}

GetFilter

Returns a list of filters that belong to that client.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

filter_id

required

string <uuid>

The uuid identifier of the filter.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
400
401
500

Content type

application/json

{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
}

UpdateFilter

This method will update an individual filter.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

filter_id

required

string <uuid>

The uuid identifier of the filter.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.

Request Body schema: application/json

Filter entity object.

uuid required	string^[a-z0-9_-]{1,128}$ Filter UUID.
name required	string^[a-z0-9_-]{1,128}$ Filter Name.
required	object Filter parameters specifying the search query terms.

Responses

Request samples

Payload

Content type

application/json

{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
}

Response samples

201
400
401
500

Content type

application/json

{"uuid": "01230123-0440-4000-8000-909090ababab",
"name": "filter-name",
"filter_params": {"keyword": "test",
"origins": ["origin1",
"origin2"
],
"tags": ["tag1",
"tag2"
],
"op_tag": "op_tag1",
"all_tags": true,
"content_type": ["content_type1",
"content_type2"
],
"date_start": "day_start1",
"date_end": "day_end1",
"date_timezone": "date_timezone1"
}
}

DeleteFilter

This method will delete an individual filter.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

filter_id

required

string <uuid>

The uuid identifier of the filter.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"message": "The filter has been deleted."
}

GeoLocations

GetGeoLocations-Country

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

search

required

string

A search string of at least 3 characters.

Responses

Response samples

200
403
500

Content type

application/json

[{"code": "AS",
"name": "American Samoa"
},
{"code": "CA",
"name": "Canada"
},
{"code": "CF",
"name": "Central African Republic"
},
{"code": "DO",
"name": "Dominican Republic"
}
]

GetGeoLocations-Region

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

search required	string A search string of at least 3 characters.
country required	string Name of country in full name in which the region lies.

Responses

Response samples

200
403
500

Content type

application/json

[{"code": "CA",
"name": "California"
},
{"code": "PA",
"name": "Pennsylvania"
},
{"code": "VA",
"name": "Virginia"
},
{"code": "WV",
"name": "West Virginia"
}
]

GetGeoLocations-City

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

search required	string A search string of at least 3 characters.
country required	string Name of country in full name in which the region lies.
city required	string Name of region in full name in which the city lies.

Responses

Response samples

200
403
500

Content type

application/json

[{"code": "Sterling Forest",
"name": "Sterling Forest"
},
{"code": "Forest Hills",
"name": "Forest Hills"
},
{"code": "Forestburgh",
"name": "Forestburgh"
}
]

Goal

GetGoals

Get a list of goals.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.
global	boolean If set to "true", the retrieved goals will also include all global goals. If set to "false", the retrieved goals will not include any global goals. If this parameter is absent, then the retrieved global goals will depend on the value of "limit_by_site" parameter - 1) if "limit_by_site" is "true", then no global goals will be returned; 2) if "limit_by_site" is "false", the all global goals will be returned.
limit_by_site	boolean Default: false If set to "true", the retrieved goals will also include the site-specific goals of the site_id. If set to "false", the retrieved site-specific goals will depend on the value of "global" parameter - 1) if "global" is "true", then no site-specific goals will be returned; 2) if "global" is "false" or absent, then all site-specific goals of ALL customer sites will be returned.
rule_id	string The rule identifier to which the retrieved goals should be associated. Can be provided multiple times to get goals from all those rule identifiers.

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "pDX4dc29tZWlkZW50aWZlcg",
"name": "Purchase",
"description": "Winter promotion",
"rule_ids": ["rule-1",
"rule-2"
],
"site_ids": ["site-1"
],
"event_names": ["purchase"
],
"global": false,
"value": "100"
},
{"id": "kZW50aWZlcg9tZWlkZW50lcg",
"name": "Subscribe",
"description": "Mailing list",
"rule_ids": ["rule-3",
"rule-4"
],
"site_ids": ["site-1"
],
"event_names": ["form_submit"
],
"global": true,
"value": "50"
}
]

CreateGoal

Create/Update a new goal. When POST'ing a goal with the same identifier, it will update that existing goal.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

Filter entity object.

id required	string <= 100 characters Goal UID.
name required	string <= 200 characters Human readable name of the goal.
description required	string <= 4000 characters Description of the goal.
rule_ids	Array of strings >= 0 items unique One of more rule identifiers.
site_ids	Array of strings >= 0 items unique One of more site identifiers.
event_names required	Array of strings non-empty unique One or more event names.
global required	boolean Defines if this goal applies to all customers sites or just the ones defined.
value	string Empty or numeric value (float).

Responses

Request samples

Payload

Content type

application/json

{"id": "pDX4dc29tZWlkZW50aWZlcg",
"name": "Purchase",
"description": "Winter promotion",
"rule_ids": ["rule-1",
"rule-2"
],
"site_ids": ["site-1"
],
"event_names": ["purchase"
],
"global": false,
"value": "100"
}

Response samples

200
400
401
500

Content type

application/json

{"id": "pDX4dc29tZWlkZW50aWZlcg",
"name": "Purchase",
"description": "Winter promotion",
"rule_ids": ["rule-1",
"rule-2"
],
"site_ids": ["site-1"
],
"global": false,
"event_names": ["purchase"
],
"value": "100"
}

GetGoal

Get a unique goal

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

goal_id

string <uuid>

The UUID of the goal.

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": "pDX4dc29tZWlkZW50aWZlcg",
"name": "Purchase",
"description": "Winter promotion",
"rule_ids": ["rule-1",
"rule-2"
],
"site_ids": ["site-1"
],
"event_names": ["purchase"
],
"global": false,
"value": "100"
}

DeleteGoal

Delete an individual goal.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

goal_id

string <uuid>

The UUID of the goal.

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

400
401
500

Content type

application/json

{"error": "Could not extract site_id."
}

Rules

MigrateRulesByAccountId

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
401
500

Content type

application/json

{"success": 13
}

GetMigrationRules

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
401
500

Content type

application/json

[{"rule_id": "test-rule-id-1",
"site_id": "test-site-id-1",
"migrated": false
},
{"rule_id": "test-rule-id-2",
"site_id": "test-site-id-1",
"migrated": true
},
{"rule_id": "test-rule-id-3",
"site_id": "test-site-id-2",
"migrated": false
}
]

MigrateRulesByUUIDs

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Request Body schema: application/json

List of uuids of rules to migrate.

Array ()

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
401
500

Content type

application/json

{"success": 13,
"failed": [{"id": "some-rule-id-1",
"label": "rule-1",
"error_code": 400,
"error_message": "Rule does not exist"
},
{"id": "some-rule-id-2",
"label": "rule-2",
"error_code": 500,
"error_message": "Issue Adding the new campaign"
},
{"id": "some-rule-id-3",
"label": "rule-3",
"error_code": 400,
"error_message": "Label is not unique"
}
]
}

GetRules

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
start	integer Default: 0 Where to start from. Eg if you have 20 items, and you fill in 10 as your start number, it will give you all the items from 10 till 19 if the amount of items you request is 10.
rows	integer Default: 10 Amount of items to return.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
context_language	string Example: context_language=fr REQUIRED if passing cdf_version=2. The 2 or 4 letter language code of the desired piece of content.
sort_field	string Enum: "created" "updated" "id" "priority" Sorting field options: created, updated, id, and priority.
sort	string Enum: "asc" "desc" Sorting order. Can be 'asc' or 'desc'
status	string Enum: "published" "unpublished" "archived" Sorting field options: Filter the list of rules by its status.
slot_id	string <uuid> Filter the list of rules by a single slot_id.
nocache	boolean Do we want to receive cached result or not?

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "rule-1",
"label": "Front page banner personalization for Belgians",
"segment": "belgians",
"priority": 10,
"status": "published",
"type": "dynamic",
"description": "Front page banner personalization for Belgians",
"campaign_id": "campaign-123",
"page_to_personalize": "http://google.com",
"created": "2018-01-05T22:04:39.880Z",
"updated": "2018-01-05T22:04:39.880Z",
"testconfig": {"dynamic": [{"slot_id": "slot-1",
"filter_id": "filter-1",
"algorithm": "most_recent",
"view_mode_id": "banner-wide-1",
"count": 1,
"exclude_viewed_content": true,
"contents": [{"id": "front-banner-1",
"title": "banner-title-1",
"base_url": "www.site-1.com",
"view_mode": {"id": "banner-wide-1",
"language": "en",
"rendered_id": "test-rendered-id-1",
"label": "banner-wide-1",
"html": "<div>Some html text</div>",
"preview_image": "path-to-the-preview-image"
}
}
]
},
{"slot_id": "slot-2",
"filter_id": "filter-2",
"algorithm": "most_viewed",
"view_mode_id": "banner-wide-2",
"count": 1,
"exclude_viewed_content": true,
"contents": [{"id": "front-banner-2",
"title": "banner-title-2",
"base_url": "www.site-1.com",
"view_mode": {"id": "banner-wide-2",
"language": "en",
"rendered_id": "test-rendered-id-2",
"label": "banner-wide-2",
"html": "<div>Some html text</div>",
"preview_image": "path-to-the-preview-image"
}
}
]
}
]
}
},
{"id": "rule-2",
"label": "Personalization for the front page of the Red Sox",
"segment": "redsox",
"priority": 8,
"status": "published",
"type": "target",
"description": "Personalization for the front page of the Red Sox",
"campaign_id": "campaign-123",
"page_to_personalize": "http://google.com",
"created": "2018-01-05T22:04:39.880Z",
"updated": "2018-01-05T22:04:39.880Z",
"testconfig": {"target": [{"slot_id": "slot_1",
"contents": [{"id": "front-banner-1",
"title": "banner-title-1",
"base_url": "www.site-1.com",
"view_mode": {"id": "banner-wide-1",
"language": "en",
"rendered_id": "test-rendered-id-1",
"label": "banner-wide-1",
"html": "<div>Some html text</div>",
"preview_image": "path-to-the-preview-image"
}
}
]
},
{"slot_id": "slot_2",
"contents": [{"id": "front-banner-2",
"title": "banner-title-2",
"base_url": "www.site-1.com",
"view_mode": {"id": "banner-wide-2",
"language": "en",
"rendered_id": "test-rendered-id-2",
"label": "banner-wide-2",
"html": "<div>Some html text</div>",
"preview_image": "path-to-the-preview-image"
}
}
]
}
]
}
},
{"id": "rule-3",
"label": "Front page banner personalization for Coffee",
"segment": "coffee",
"priority": 5,
"status": "published",
"type": "ab",
"description": "Front page banner personalization for Coffee",
"campaign_id": "campaign-15",
"page_to_personalize": "http://google.com",
"created": "2018-01-05T22:04:39.880Z",
"updated": "2018-01-05T22:04:39.880Z",
"testconfig": {"ab": [{"variation_id": "variation_A",
"variation_label": "variation for A customers",
"probability": 0.35,
"slots": [{"slot_id": "slot_1",
"contents": [{"id": "front-banner-1",
"title": "banner-title-1",
"base_url": "www.site-1.com",
"view_mode": {"id": "banner-wide-1",
"language": "en",
"rendered_id": "test-rendered-id-1",
"label": "banner-wide-1",
"html": "<div>Some html text</div>",
"preview_image": "path-to-the-preview-image"
}
}
]
}
]
},
{"variation_id": "variation_B",
"variation_label": "variation for B customers",
"probability": 0.65,
"slots": [{"slot_id": "slot_2",
"contents": [{"id": "front-banner-2",
"title": "banner-title-2",
"base_url": "www.site-1.com",
"view_mode": {"id": "banner-wide-2",
"language": "en",
"rendered_id": "test-rendered-id-2",
"label": "banner-wide-2",
"html": "<div>Some html text</div>",
"preview_image": "path-to-the-preview-image"
}
}
]
}
]
}
]
}
}
]

CreateRule

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
context_language	string Example: context_language=fr REQUIRED if passing cdf_version=2. The 2 or 4 letter language code of the desired piece of content.

Request Body schema: application/json

JSON representation of a rule object.

id required	string^[a-z0-9_-]{1,128}$ Rule UID.
label required	string Human readable label for the given rule.
priority	integer The order in which a rule will be evaluated for a slot. Rules with a higher priority are processed first.
description	string
campaign_id required	string The campaign that this rule is associated with.
segment	string^[a-z0-9_-]{1,128}$ Segment this rule applies to. Applies to all segments if left empty.
status required	string Enum: "unpublished" "scheduled" "published" "completed" "archived" Status of the Rule. Defaults to unpublished. Must match the status of the campaign if attached to a campaign.
type required	string Enum: "target" "ab" "dynamic" Type of the rule. Must match the type of the testconfig. Empty testconfig matches any type.
	any or any or any

Responses

Request samples

Payload

Content type

application/json

Example

{"id": "rule-1",
"label": "Front page banner personalization for Belgians",
"segment": "belgians",
"priority": 10,
"status": "unpublished",
"type": "target",
"description": "Front page banner personalization for Belgians",
"campaign_id": "campaign-123",
"page_to_personalize": "http://acquia.com",
"testconfig": {"target": [{"slot_id": "slot_1",
"contents": [{"id": "front-banner-1",
"view_mode": {"id": "banner-wide-1"
}
}
]
},
{"slot_id": "slot_2",
"contents": [{"id": "front-banner-2",
"view_mode": {"id": "banner-wide-2"
}
}
]
}
]
}
}

Response samples

201
400
401
500

Content type

application/json

Example

"{\n  \"id\": \"rule-1\",\n  \"label\": \"Front page banner personalization for Belgians\",\n  \"segment\": \"belgians\",\n  \"priority\": 10,\n  \"status\": \"unpublished\",\n  \"type\": \"target\",\n  \"description\": \"Front page banner personalization for Belgians\",\n  \"campaign_id\": \"campaign-123\",\n  \"page_to_personalize\": \"http://acquia.com\",\n  \"testconfig\": {\n    \"target\": [\n      {\n        \"slot_id\": \"slot_1\",\n        \"contents\": [\n          {\n            \"id\": \"front-banner-1\",\n            \"view_mode\": {\n              \"id\": \"banner-wide-1\"\n            }\n          }\n        ]\n      },\n      {\n        \"slot_id\": \"slot_2\",\n        \"contents\": [\n          {\n            \"id\": \"front-banner-2\",\n            \"view_mode\": {\n              \"id\": \"banner-wide-2\"\n            }\n          }\n        ]\n      }\n    ]\n  }\n}\n"

DeleteRules

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

400
401
500

Content type

application/json

{"error": "Could not extract site_id."
}

GetRule

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

rule_id

required

string <uuid>

Identifier of a rule.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
cdf_version	integer Enum: 1 2 The CDF version used in content provider. Can accept value of empty string, 1 or 2. Default value is 1.
context_language	string Example: context_language=fr REQUIRED if passing cdf_version=2. The 2 or 4 letter language code of the desired piece of content.
nocache	boolean Do we want to receive cached result or not?

Responses

Response samples

200
400
401
404
500

Content type

application/json

Example

{"id": "rule-1",
"label": "Front page banner personalization for Belgians",
"segment": "belgians",
"priority": 10,
"status": "unpublished",
"type": "target",
"description": "Front page banner personalization for Belgians",
"campaign_id": "campaign-123",
"page_to_personalize": "http://acquia.com",
"testconfig": {"target": [{"slot_id": "slot_1",
"contents": [{"id": "front-banner-1",
"view_mode": {"id": "banner-wide-1"
}
}
]
},
{"slot_id": "slot_2",
"contents": [{"id": "front-banner-2",
"view_mode": {"id": "banner-wide-2"
}
}
]
}
]
}
}

UpdateRule

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

rule_id

required

string <uuid>

Identifier of a rule.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Request Body schema: application/json

Update a singular characteristic of a Rule through the PATCH endpoint. Currently the endpoint only supports updating segment, priority, description, and label.

label	string [ 1 .. 255 ] characters Label applied to a campaign
description	string <= 64000 characters Description of the campaign.
segment	string^[a-z0-9_-]{1,128}$ Segment this rule applies to. Applies to all segments if left empty.
priority	integer The order in which a rule will be evaluated for a slot. Rules with a higher priority are processed first.

Responses

Request samples

Payload

Content type

application/json

{"label": "New Rule Label",
"description": "New Rule",
"priority": 10,
"segment": "search"
}

Response samples

200
400
401
500

Content type

application/json

Example

{"id": "rule-1",
"label": "Front page banner personalization for Belgians",
"segment": "belgians",
"priority": 10,
"status": "unpublished",
"type": "target",
"description": "Front page banner personalization for Belgians",
"campaign_id": "campaign-123",
"testconfig": {"target": [{"slot_id": "slot_1",
"contents": [{"id": "front-banner-1",
"view_mode": {"id": "banner-wide-1"
}
}
]
},
{"slot_id": "slot_2",
"contents": [{"id": "front-banner-2",
"view_mode": {"id": "banner-wide-2"
}
}
]
}
]
}
}

DeleteRule

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

rule_id

required

string <uuid>

Identifier of a rule.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

400
401
500

Content type

application/json

{"error": "Could not extract site_id."
}

Pages

GetPages

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
start	integer Default: 0 Where to start from. Eg if you have 20 items, and you fill in 10 as your start number, it will give you all the items from 10 till 19 if the amount of items you request is 10.
rows	integer Default: 10 Amount of items to return.
pageurl	string Filter results by page url (ie. "/", "/index.html").
sort_field	string Enum: "pages" "campaigns" "slots" Sort results by page url, number of campaigns or number of slots. Default is set to sort query by page url.
sort	string Enum: "asc" "desc" Indicate to order query by ascending or descending.

Responses

Response samples

200
400
401
500

Content type

application/json

{"total_count": 10,
"start": 0,
"rows": 10,
"pages": [{"id": "b6d14b0d-9cff-44d6-63fc-d50485564e64",
"page_url": "/index.html",
"campaigns": 5,
"slots": 8
},
{"id": "1c035a37-4799-4e43-78d6-1a493d65031b",
"page_url": "/main.html",
"campaigns": 1,
"slots": 3
}
]
}

GetPage

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
400
401
500

Content type

application/json

[{"slot_id": "{some-uuid}",
"slot_label": "slot-name",
"campaigns": [{"campaign_id": "{some-uuid}",
"campaign_name": "campaign-name",
"campaign_type": "mixed",
"rules": [{"rule_id": "{some-uuid}",
"rule_name": "rule-name",
"rule_type": "dynamic",
"segment_name": "segment-name"
}
]
}
]
}
]

Ping

Responses

Response samples

200

Content type

application/json

{"message": "Pong!"
}

Segments

GetSegmentsByAccount

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
format	string Enum: "v1" "v2" Format 'v1' will output a list of segments without pagination fields. Format 'v2' will return responses with pagination fields

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "belgians",
"name": "Belgians",
"description": "Segment for the Belgians"
},
{"id": "canadians",
"name": "Canadians",
"description": "Segment for the Canadians"
}
]

CreateSegment

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a segment object.

id	string <= 100 characters Segment Id.
name required	string <= 100 characters Human readable name of the segment.
description required	string <= 3000 characters Human readable description of the segment.
site_ids	Array of strings >= 0 items unique Optional list of customer sites.
	object (Segment V2)

Responses

Request samples

Payload

Content type

application/json

Example

"{\n  \"id\": \"test_segment\",\n  \"name\": \"Test Segment\",\n  \"description\": \"Testing Segment POST API\",\n  \"tree\": {\n      \"children_op\": \"ALL\",\n      \"children\": [\n          {\n              \"column_metadata_id\": 43167,\n              \"category\": \"Event Count\",\n              \"subcategory\": \"Events\",\n              \"op\": \"GTE\",\n              \"value\": 1,\n              \"time_period\": \"PAST_30_DAYS\",\n              \"event_id\": 13852,\n              \"event_name\": \"Content View\",\n              \"children\": [\n                  {\n                      \"children_op\": \"ANY\",\n                      \"children\": [\n                          {\n                              \"column_metadata_id\": 11613,\n                              \"category\": \"Client Time\",\n                              \"subcategory\": \"Day of Month\",\n                              \"op\": \"EQUALS\",\n                              \"value\": \"02\"\n                          }\n                      ]\n                  }\n              ]\n          }\n      ]\n  }\n}\n"

Response samples

200
400
401
500

Content type

application/json

Example

"{\n  \"id\": \"test_segment\",\n  \"name\": \"Test Segment\",\n  \"description\": \"Testing Segment POST API\",\n  \"tree\": {\n      \"children_op\": \"ALL\",\n      \"children\": [\n          {\n              \"column_metadata_id\": 43167,\n              \"category\": \"Event Count\",\n              \"subcategory\": \"Events\",\n              \"op\": \"GTE\",\n              \"value\": 1,\n              \"time_period\": \"PAST_30_DAYS\",\n              \"event_id\": 13852,\n              \"event_name\": \"Content View\",\n              \"children\": [\n                  {\n                      \"children_op\": \"ANY\",\n                      \"children\": [\n                          {\n                              \"column_metadata_id\": 11613,\n                              \"category\": \"Client Time\",\n                              \"subcategory\": \"Day of Month\",\n                              \"op\": \"EQUALS\",\n                              \"value\": \"02\"\n                          }\n                      ]\n                  }\n              ]\n          }\n      ]\n  }\n}\n"

DeleteSegments

This method allows deletion of a specific segment associated with an account.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
500

Content type

plain/text

Segments has been deleted successfully.

GetSegmentsById

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": "test_segment",
"name": "Test Segment",
"description": "Testing Segment POST API",
"tree": {"children_op": "ALL",
"children": [{"column_metadata_id": 43167,
"category": "Event Count",
"subcategory": "Events",
"op": "GTE",
"value": 1,
"time_period": "PAST_30_DAYS",
"event_id": 13852,
"event_name": "Content View",
"children": [{"children_op": "ANY",
"children": [{"column_metadata_id": 11613,
"category": "Client Time",
"subcategory": "Day of Month",
"op": "EQUALS",
"value": "02"
}
]
}
]
}
]
}
}

DeleteSegment

This method allows deletion of a specific segment associated with an account.

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
404
500

Content type

plain/text

Segment has been deleted successfully.

GetSegmentsMetadata

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
400
401
500

Content type

application/json

[{"category": "Content History",
"description": "History of content that client previously visited",
"subcategories": [{"id": 43165,
"name": "Keyword Count",
"description": "A count of the number of times a user has seen a keyword of a given value",
"operators": ["EQUALS",
"GT",
"GTE",
"LT",
"LTE"
],
"terms": "Keywords",
"value_type": "INTEGER",
"time_periods": ["CURRENT_TOUCH",
"PAST_24_HOURS",
"TODAY",
"PAST_7_DAYS",
"PAST_30_DAYS",
"PAST_60_DAYS",
"PAST_90_DAYS"
]
},
{"id": 43166,
"name": "Section Count",
"description": "A count of the number of times a user has seen a section of a given value",
"operators": ["EQUALS",
"GT",
"GTE",
"LT",
"LTE"
],
"terms": "Sections",
"value_type": "INTEGER",
"time_periods": ["CURRENT_TOUCH",
"PAST_24_HOURS",
"TODAY",
"PAST_7_DAYS",
"PAST_30_DAYS",
"PAST_60_DAYS",
"PAST_90_DAYS"
]
}
]
},
{"category": "Current System Info",
"description": "System information on what the client is using to access the content",
"subcategories": [{"id": 43146,
"name": "Browser",
"description": "Browser used for this touch",
"operators": ["MATCHES_ONE_OF"
],
"default_values": [{"display_value": "Chrome",
"internal_value": "CHROME"
},
{"display_value": "Firefox",
"internal_value": "FIREFOX"
},
{"display_value": "Internet Explorer",
"internal_value": "IE"
},
{"display_value": "Opera",
"internal_value": "OPERA"
},
{"display_value": "Other",
"internal_value": "OTHER"
}
],
"value_type": "STRING"
},
{"id": 43145,
"name": "Platform",
"description": "Platform used for this touch",
"operators": ["MATCHES_ONE_OF"
],
"default_values": [{"display_value": "Desktop",
"internal_value": "DESKTOP"
},
{"display_value": "Game Console",
"internal_value": "GAME_CONSOLE"
},
{"display_value": "Mobile",
"internal_value": "MOBILE"
},
{"display_value": "Tablet",
"internal_value": "TABLET"
},
{"display_value": "Other",
"internal_value": "OTHER"
}
],
"value_type": "STRING"
},
{"id": 43144,
"name": "System",
"description": "Operating system (OS) used for this touch",
"operators": ["MATCHES_ONE_OF"
],
"value_type": "STRING"
}
]
},
{"category": "Event Count",
"description": "Any action that occurs as a result of the user (or another) source",
"subcategories": [{"id": 43167,
"name": "Events",
"description": "Name of the event (for example, Content View)",
"operators": ["EQUALS",
"GT",
"GTE",
"LT",
"LTE"
],
"value_type": "INTEGER",
"time_periods": ["CURRENT_TOUCH",
"PAST_24_HOURS",
"TODAY",
"PAST_7_DAYS",
"PAST_30_DAYS"
],
"customer_sites": [{"name": "<Global>",
"events": [{"id": 13853,
"name": "Campaign Action"
},
{"id": 13854,
"name": "Campaign Click Through"
},
{"id": 13857,
"name": "Click-Through"
},
{"id": 13852,
"name": "Content View"
},
{"id": 13855,
"name": "Decision"
},
{"id": 13856,
"name": "Goal"
},
{"id": 13859,
"name": "Newsletter subscription"
},
{"id": 13858,
"name": "Product purchase"
}
],
"site_id": ""
},
{"name": "Test Site Id 1",
"events": [ ],
"site_id": "test-site-id-1"
}
]
}
]
}
]

Settings

GetClientSettings

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
500

Content type

application/json

{"content_replacement_js_file": "mydomain.example/reply.js",
"lift_capture_js_enabled": "true",
"lift_capture_bootstrap_js_file": "mydomain.example/lift-capture-bootstrap.js"
}

CreateClientSettings

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

Set the client specific settings. Always post the full settings schema. The server-side application will take care of only updating the changed values.

content_replacement_js_file	string <= 255 characters A customer specific reply.js that will be used.
lift_capture_js_enabled	string <= 255 characters Enable Lift Profile Manager specific JS.
lift_capture_bootstrap_js_file	string <= 255 characters Specify the specific Lift Profile Manager Capture bootstrap file to be used for this customer.

Responses

Request samples

Payload

Content type

application/json

{"$schema": "http://json-schema.org/draft-04/schema#",
"id": "settings.json",
"title": "Settings",
"type": "object",
"properties": {"content_replacement_js_file": {"description": "A customer specific reply.js that will be used.",
"type": "string",
"maxLength": 255
},
"lift_capture_js_enabled": {"description": "Enable Lift Profile Manager specific JS.",
"type": "string",
"maxLength": 255
},
"lift_capture_bootstrap_js_file": {"description": "Specify the specific Lift Profile Manager Capture bootstrap file to be used for this customer.",
"type": "string",
"maxLength": 255
}
}
}

Response samples

200
401
500

Content type

application/json

{"content_replacement_js_file": "mydomain.example/reply.js",
"lift_capture_js_enabled": "true",
"lift_capture_bootstrap_js_file": "mydomain.example/lift-capture-bootstrap.js"
}

Slots

GetSlots

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
status	string Enum: "enabled" "disabled" Filter the list of slots by its status.

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "slot-1",
"label": "Slot 1",
"description": "Slot 1. Useful for banners on frontpage",
"css_selector": "btn.awesome",
"status": "enabled",
"visibility": {"pages": ["<front>"
],
"condition": "show"
},
"created": "2015-09-09T06:28:16.020Z",
"updated": "2015-09-09T06:28:16.020Z"
},
{"id": "slot-2",
"label": "Slot 2",
"description": "Acquia Lift Slot 2",
"css_selector": "btn.more-awesome",
"status": "enabled",
"visibility": {"pages": ["<front>"
],
"condition": "hide"
},
"created": "2015-09-09T06:28:16.020Z",
"updated": "2015-09-09T06:28:16.020Z"
},
{"id": "slot-3",
"label": "Slot 3",
"description": "Acquia Lift Slot 3",
"css_selector": "btn.sad",
"status": "disabled",
"visibility": {"pages": ["<front>"
],
"condition": "show"
},
"created": "2015-09-09T06:28:16.020Z",
"updated": "2015-09-09T06:28:16.020Z"
}
]

CreateSlot

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Request Body schema: application/json

JSON representation of a slot object.

id required	string^[a-z0-9_-]{1,128}$ Slot UID.
label	string Human readable label for the given slot.
description	string Human readable description what this specific slot is and what its purpose is.
css_selector	string The CSS selector that can be used for the Lift Experience Builder to auto-select a particular html entity as the slot.
status required	string Enum: "enabled" "disabled" Status of the slot
	object (Visibility Options) Define where this rule is visible at and allows for the inclusion or exclusion of the path patterns
created required	string <date-time> Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
updated	string <date-time> Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Responses

Request samples

Payload

Content type

application/json

{"id": "slot-1",
"label": "Slot 1",
"description": "Acquia Lift Slot 1. Useful for banners on frontpage",
"css_selector": "btn.awesome",
"status": "enabled",
"visibility": {"pages": ["<front>"
],
"condition": "show"
}
}

Response samples

200
400
401
500

Content type

application/json

{"id": "slot-1",
"label": "Slot 1",
"description": "Acquia Lift Slot 1. Useful for banners on frontpage",
"css_selector": "btn.awesome",
"status": "enabled",
"visibility": {"pages": ["<front>"
],
"condition": "show"
},
"created": "2015-09-09T06:28:16.020Z",
"updated": "2015-09-09T06:28:16.020Z"
}

DeleteSlots

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

400
401
500

Content type

application/json

{"error": "Could not extract site_id."
}

GetSlot

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

slot_id

required

string <uuid>

Unique id of a slot.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": "slot-1",
"label": "Slot 1",
"description": "Slot 1. Useful for banners on frontpage",
"css_selector": "btn.awesome",
"status": "enabled",
"visibility": {"pages": ["<front>"
],
"condition": "show"
},
"created": "2015-09-09T06:28:16.020Z",
"updated": "2015-09-09T06:28:16.020Z"
}

DeleteSlot

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

path Parameters

slot_id

required

string <uuid>

Unique id of a slot.

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

400
401
500

Content type

application/json

{"error": "Could not extract site_id."
}

Stats

DeleteStats

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id	string <= 20 characters The customer site matching site_id in the configuration database.

Responses

Response samples

401
500

Content type

application/json

{"error": "Could not extract account_id."
}

Usergroups

GetUserGroups

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"userGroupId": 13083,
"name": "Lift 4 End-to-End Testings Administrators",
"description": "Lift 4 End-to-End Testings Administrators Group"
},
{"userGroupId": 13084,
"name": "Lift 4 End-to-End Testings Api Users",
"description": "Lift 4 End-to-End Testings Api Users Group"
},
{"userGroupId": 13085,
"name": "Lift 4 End-to-End Testings Users",
"description": "Lift 4 End-to-End Testings Users Group"
},
{"userGroupId": 13086,
"name": "Lift 4 End-to-End Testings Content Hub Administrators",
"description": "Lift 4 End-to-End Testings Content Hub Administrators Group"
},
{"userGroupId": 13087,
"name": "Lift 4 End-to-End Testings Full Api Users",
"description": "Lift 4 End-to-End Testings Full Api Users Group"
}
]

GetUserGroup

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
403
500

Content type

application/json

{"userGroupId": 13083,
"name": "Lift 4 End-to-End Testings Administrators",
"description": "Lift 4 End-to-End Testings Administrators Group"
}

Users

GetUsers

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"object": "user",
"userId": "REVDQVBJQ0kzQ0RGMi5hcGl1c2VyQGFjcXVpYS5jb20=",
"fullName": "Anonymous API User",
"enabled": true,
"emailAddress": "DECAPICI3CDF2.apiuser@acquia.com",
"secGroupId": 19828,
"accessKeyId": "fU7wOL3w31joHzXWEKdf",
"secretAccessKey": "rCJZVS34idHjPSjlXAB6w739suBQmwHg9eZES67n"
},
{"object": "user",
"userId": "REVDQVBJQ0kzQ0RGMi5jb250ZW50aHViQGFjcXVpYS5jb20=",
"fullName": "Content Hub Admin User",
"enabled": true,
"emailAddress": "DECAPICI3CDF2.contenthub@acquia.com",
"secGroupId": 19830,
"accessKeyId": "VkDne1r4Ae2U9gNe48dM",
"secretAccessKey": "Ms3wcrVTefc3LMyMumOG8WBq8dgxI2mifCTaBu6I"
}
]

CreateUser

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a user post object.

fullName required	string Display name of User
emailAddress required	string Email Address of User
secGroupId required	number User associated with user id
plainPassword required	string User password
enabled	boolean Active status flag
passwordChangeRequired	boolean Forces user to change password on login if flag is set to true
sendEmail	boolean Send email notification to user when flag is set to true

Responses

Request samples

Payload

Content type

application/json

{"fullName": "Anonymous API User",
"emailAddress": "DECAPICI3CDF2.apiuser@acquia.com",
"secGroupId": 19828,
"plainPassword": "Password1234",
"enabled": true,
"passwordChangeRequired": false,
"sendEmail": false
}

Response samples

200
400
401
403
500

Content type

application/json

{"object": "user",
"userId": "REVDQVBJQ0kzQ0RGMi5hcGl1c2VyQGFjcXVpYS5jb20=",
"fullName": "Anonymous API User",
"enabled": true,
"emailAddress": "DECAPICI3CDF2.apiuser@acquia.com",
"secGroupId": 19828,
"accessKeyId": "fU7wOL3w31joHzXWEKdf",
"secretAccessKey": "rCJZVS34idHjPSjlXAB6w739suBQmwHg9eZES67n"
}

GetUser

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"object": "user",
"userId": "REVDQVBJQ0kzQ0RGMi5hcGl1c2VyQGFjcXVpYS5jb20",
"fullName": "Anonymous API User",
"enabled": true,
"emailAddress": "DECAPICI3CDF2.apiuser@acquia.com",
"secGroupId": 19828,
"accessKeyId": "fU7wOL3w31joHzXWEKdf",
"secretAccessKey": "rCJZVS34idHjPSjlXAB6w739suBQmwHg9eZES67n"
}

DeleteUser

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Responses

Response samples

401
403
404
500

Content type

application/json

{"error": "Missing url parameter account_id."
}

UpdateUser

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id

required

string <= 20 characters

The customer account_id in the configuration database.

Request Body schema: application/json

JSON representation of a user put object.

fullName required	string Display name of User
secGroupId required	number User associated with user id
plainPassword required	string User password
enabled	boolean Active status flag
passwordChangeRequired	boolean Forces user to change password on login if flag is set to true
sendEmail	boolean Send email notification to user when flag is set to true

Responses

Request samples

Payload

Content type

application/json

{"fullName": "Anonymous API User",
"secGroupId": 19828,
"plainPassword": "Password1234",
"enabled": true,
"passwordChangeRequired": false,
"sendEmail": false
}

Response samples

200
401
403
404
500

Content type

application/json

{"object": "user",
"userId": "REVDQVBJQ0kzQ0RGMi5hcGl1c2VyQGFjcXVpYS5jb20=",
"fullName": "Anonymous API User",
"enabled": true,
"emailAddress": "DECAPICI3CDF2.apiuser@acquia.com",
"secGroupId": 19828,
"accessKeyId": "fU7wOL3w31joHzXWEKdf",
"secretAccessKey": "rCJZVS34idHjPSjlXAB6w739suBQmwHg9eZES67n"
}

View modes

GetViewModeIds

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
site_id required	string <= 20 characters The customer site matching site_id in the configuration database.
nocache	boolean Do we want to receive cached result or not?

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "teaser",
"label": "Teaser"
},
{"id": "full",
"label": "Full Content"
},
{"id": "rss",
"label": "RSS"
}
]

Visitor query

GetVisitorInfo

Authorizations:

HmacAuthorizationHmacAuthenticatedIdHmacAuthorizationTimestampHmacAuthorizationContentSHA256

query Parameters

account_id required	string <= 20 characters The customer account_id in the configuration database.
identifier required	string Visitor's identity information.
identifier_type required	string Type of visitor's identity information - must be account, email, facebook, tracking, twitter, or any custom resolvable identifier.
person_tables required	string Data table values to return - must be identifiers, person, touch, event, or any comma-delimited combination of these values.

Responses

Response samples

200
401
500

Content type

application/json

{"person": {"id": 12007,
"engagementScore": 0,
"lastTouch": "2015-10-20T14:19:13Z",
"firstTouch": "2015-10-20T14:19:13Z",
"firstTimeVisitor": true,
"subscriberStatus": "Unknown",
"customerId": 10008,
"primaryIdentifier": "7RBYAsUXsXH6L5V871y0RO",
"primaryIdentifierTypeId": 2,
"active": true,
"lastModifiedDate": "2015-10-20T18:19:20Z",
"anonymousVisitor": false,
"doNotTrack": false,
"person_udf1": "test-custom-value1",
"person_udf2": "test-custom-value2"
},
"identifiers": [{"id": 12611,
"identifier": "qa100",
"personIdentifierTypeId": 6,
"personId": 12007,
"customerId": 10008,
"active": true
},
{"id": 12610,
"identifier": "qa100@example.com",
"personIdentifierTypeId": 1,
"personId": 12007,
"customerId": 10008,
"active": true
},
{"id": 12609,
"identifier": "7RBYAsUXsXH6L5V871y0RO",
"personIdentifierTypeId": 2,
"personId": 12007,
"customerId": 10008,
"active": true
}
],
"touches": [{"id": 12212,
"touchDuration": 0,
"touchDurationInSeconds": 0,
"touchDate": "2015-10-20T14:19:13Z",
"channelType": "twitter",
"engagementScore": 0,
"referrer": "Direct",
"referrerDomain": "Direct",
"numberOfPageViews": 1,
"identifier": "33tpvFowlnHW7rNquqtmq5",
"lastModifiedDate": "2015-10-20T18:19:20Z",
"personId": 12007,
"customerId": 10008,
"personIdentifierId": 12609,
"touch_udf1": "test-custom-value1",
"touch_udf2": "test-custom-value2",
"events": [{"id": 17619,
"name": "Content View",
"eventDate": "2015-10-20T14:19:13Z",
"eventCategoryType": "OTHER",
"accountId": "<account_id>",
"referrer": "Direct",
"captureIdentifier": "2zkT5TXrcC92HmKqMAq1Yc",
"touchId": 12212,
"personId": 12007,
"customerId": 10008,
"eventCategoryId": 10046,
"clientDate": "2015-10-20T14:19:13Z",
"clientTimezone": "America/Anguilla",
"lastModifiedDate": "2015-10-20T18:19:20Z",
"contentUUID": "123e4567-e89b-12d3-a456-426655440000",
"event_udf1": "test-custom-value1",
"event_udf2": "test-custom-value2"
}
]
}
]
}