Global API
Global API meta-information.
get
/
Retrieve the global API meta-information.
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Describes the main API entry points, supported formats and specification locations.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "documentation", "related", "specifications", "supported_formats" ],
"properties" : {
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "accounts", "pages" ],
"properties" : {
"accounts" : {
"type" : "string",
"format" : "uri"
},
"pages" : {
"type" : "string",
"format" : "uri"
}
}
},
"specifications" : {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "href", "type", "version" ],
"properties" : {
"href" : {
"type" : "string",
"format" : "uri"
},
"type" : {
"type" : "string",
"enum" : [ "raml" ]
},
"version" : {
"type" : "string"
}
}
}
},
"supported_formats" : {
"type" : "array",
"item" : {
"type" : "string"
}
}
}
}
Accounts
The accounts collection is the entry point to the rest of the Unbounce API. Your API key will give you access to all of the clients owned by your primary account.
get
/accounts
Retrieve the accounts collection.
Authentication Required
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desc
Example Response
{
"accounts": [
{
"created_at": "2015-12-16T00:34:47.000Z",
"id": "1456243",
"name": "Corporate Cole's Account",
"state": "active",
"uuid": "f888109f-7851-4252-ad51-c432e0f37056",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_accounts__account_id_",
"location": "https://api.unbounce.com/accounts/1456243",
"related": {
"accounts": "https://api.unbounce.com/accounts",
"pages": "https://api.unbounce.com/accounts/1456243/pages",
"sub_accounts": "https://api.unbounce.com/accounts/1456243/sub_accounts"
}
}
}
],
"metadata": {
"count": 1,
"documentation": "https://developer.unbounce.com/api_reference/#id_accounts__account_id_",
"location": "https://api.unbounce.com/accounts",
"related": {
"root": "https://api.unbounce.com/"
}
}
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of account entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "accounts", "metadata" ],
"properties" : {
"accounts" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single account entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "id", "metadata", "name", "state" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "accounts", "sub_accounts" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"accounts" : {
"type" : "string",
"format" : "uri"
},
"sub_accounts" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
},
"state" : {
"type" : "string",
"enum" : [ "active", "suspended" ]
}
}
}
},
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
}
}
}
get
/accounts/{account_id}
Retrieve the details of a single account.
Authentication Required
URI Parameters
account_id
required string
Example Response
{
"created_at": "2015-12-16T00:34:47.000Z",
"id": "1456243",
"name": "Corporate Cole's Account",
"state": "active",
"uuid": "f888109f-7851-4252-ad51-c432e0f37056",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_accounts__account_id_",
"location": "https://api.unbounce.com/accounts/1456243",
"related": {
"accounts": "https://api.unbounce.com/accounts",
"pages": "https://api.unbounce.com/accounts/1456243/pages",
"sub_accounts": "https://api.unbounce.com/accounts/1456243/sub_accounts"
}
}
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single account entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "id", "metadata", "name", "state" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "accounts", "sub_accounts" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"accounts" : {
"type" : "string",
"format" : "uri"
},
"sub_accounts" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
},
"state" : {
"type" : "string",
"enum" : [ "active", "suspended" ]
}
}
}
get
/accounts/{account_id}/sub_accounts
Retrieve all sub-accounts for the specified account.
Authentication Required
URI Parameters
account_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"metadata": {
"count": 2,
"documentation": "https://developer.unbounce.com/api_reference/#id_sub_accounts__sub_account_id_",
"location": "https://api.unbounce.com/accounts/1456243/sub_accounts"
},
"sub_accounts": [
{
"account_id": "1456243",
"created_at": "2015-12-16T00:34:47.000Z",
"domains_count": 1,
"id": "1552433",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_sub_accounts__sub_account_id_",
"location": "https://api.unbounce.com/sub_accounts/1552433",
"related": {
"domains": "https://api.unbounce.com/sub_accounts/1552433/domains",
"page_groups": "https://api.unbounce.com/sub_accounts/1552433/page_groups",
"pages": "https://api.unbounce.com/sub_accounts/1552433/pages"
}
},
"name": "Default Client"
},
{
"account_id": "1456243",
"created_at": "2015-12-16T00:55:54.000Z",
"domains_count": 1,
"id": "1552463",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_sub_accounts__sub_account_id_",
"location": "https://api.unbounce.com/sub_accounts/1552463",
"related": {
"domains": "https://api.unbounce.com/sub_accounts/1552463/domains",
"page_groups": "https://api.unbounce.com/sub_accounts/1552463/page_groups",
"pages": "https://api.unbounce.com/sub_accounts/1552463/pages"
}
},
"name": "Lumber James"
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of sub-account entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"sub_accounts" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a sub-account entity (API sub-accounts are Unbounce Clients).",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domains_count", "id", "account_id", "metadata", "name" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"domains_count" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"account_id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "page_groups", "domains" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"page_groups" : {
"type" : "string",
"format" : "uri"
},
"domains" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
},
"website" : {
"type" : "string"
}
}
}
}
}
}
get
/accounts/{account_id}/pages
Retrieve a list of all pages for the specified account.
Authentication Required
URI Parameters
account_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"metadata": {
"count": 3,
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/accounts/1456243/pages"
},
"pages": [
{
"created_at": "2015-12-16T00:59:29.000Z",
"domain": "unbouncepages.com",
"id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"last_published_at": "2015-12-16T01:02:23.000Z",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"related": {
"form_fields": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/form_fields",
"leads": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Forward Marketing Solutions",
"state": "published",
"sub_account_id": "1552433",
"url": "http://unbouncepages.com/forward-marketing-solutions/",
"variants_count": 0
},
{
"created_at": "2015-12-16T01:01:28.000Z",
"domain": "forward.corporatecole.com",
"id": "26d2a10b-4b00-495d-b915-978dc5b3565f",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f",
"related": {
"form_fields": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/form_fields",
"leads": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Mastering Leather E-Book",
"state": "unpublished",
"sub_account_id": "1552433",
"url": "http://forward.corporatecole.com/mastering-leather-e-book/",
"variants_count": 0
},
{
"created_at": "2015-12-16T01:00:12.000Z",
"domain": "ubacademy.wpengine.com",
"id": "1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d",
"related": {
"form_fields": "https://api.unbounce.com/pages/1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d/form_fields",
"leads": "https://api.unbounce.com/pages/1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552463"
}
},
"name": "Lumber James E-Book",
"state": "unpublished",
"sub_account_id": "1552463",
"url": "http://ubacademy.wpengine.com/lumber-james-e-book/",
"variants_count": 0
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of page entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"pages" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single page entity, which includes page statistics such as which variant is the winner or loser.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domain", "id", "integrations", "integrations_count", "integrations_errors_count", "metadata", "name", "state", "sub_account_id", "url", "variants_count" ],
"properties" : {
"integrations_count" : {
"type" : "integer"
},
"url" : {
"type" : "string",
"format" : "uri"
},
"sub_account_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"variants_count" : {
"type" : "integer"
},
"integrations_errors_count" : {
"type" : "integer"
},
"domain" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_fields", "leads", "sub_account" ],
"properties" : {
"form_fields" : {
"type" : "string",
"format" : "uri"
},
"leads" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"state" : {
"type" : "string",
"enum" : [ "unpublished", "published" ]
},
"tests" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a campaign experiment, aka a test.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "current" ],
"properties" : {
"current" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : false
}, {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
} ]
}
},
"definitions" : {
"empty_stats" : {
"type" : "object",
"additionalProperties" : false
},
"stats" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
}
}
},
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"last_published_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"integrations" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single integration entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "type", "errors_count" ],
"properties" : {
"type" : {
"type" : "string"
},
"errors_count" : {
"type" : "integer"
}
}
}
}
}
}
}
}
}
Sub Accounts
Unbounce users can use sub-accounts to manage multiple projects or clients. Each sub-account has it's own collection of pages, domains and other objects. For interactive applications, you'd often want to allow users to select a particular sub-account to work with.
get
/sub_accounts/{sub_account_id}
Retrieve the details of a single sub-account.
Authentication Required
URI Parameters
sub_account_id
required string
Example Response
{
"account_id": "1456243",
"created_at": "2015-12-16T00:34:47.000Z",
"domains_count": 1,
"id": "1552433",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_sub_accounts__sub_account_id_",
"location": "https://api.unbounce.com/sub_accounts/1552433",
"related": {
"domains": "https://api.unbounce.com/sub_accounts/1552433/domains",
"page_groups": "https://api.unbounce.com/sub_accounts/1552433/page_groups",
"pages": "https://api.unbounce.com/sub_accounts/1552433/pages"
}
},
"name": "Default Client"
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a sub-account entity (API sub-accounts are Unbounce Clients).",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domains_count", "id", "account_id", "metadata", "name" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"domains_count" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"account_id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "page_groups", "domains" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"page_groups" : {
"type" : "string",
"format" : "uri"
},
"domains" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
},
"website" : {
"type" : "string"
}
}
}
get
/sub_accounts/{sub_account_id}/domains
Retrieve a list of all custom domains belonging to a given sub-account.
Authentication Required
URI Parameters
sub_account_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"domains": [
{
"id": "1225953",
"uuid": "9216b2e8-a57b-4b13-817b-24e53b55ac21",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_domains__domain_id_",
"location": "https://api.unbounce.com/domains/1225953",
"related": {
"account": "https://api.unbounce.com/accounts/1456243",
"pages": "https://api.unbounce.com/domains/1225953/pages",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "forward.corporatecole.com"
}
],
"metadata": {
"count": 1,
"documentation": "https://developer.unbounce.com/api_reference/#id_domains__domain_id_",
"location": "https://api.unbounce.com/sub_accounts/1552433/domains",
"related": {
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
}
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of domain entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"domains" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single custom domain entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "id", "metadata", "name" ],
"properties" : {
"id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "account", "sub_account" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"account" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
}
}
}
},
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
}
}
}
get
/sub_accounts/{sub_account_id}/page_groups
Retrieve a list of all page groups for a given sub-account.
Authentication Required
URI Parameters
sub_account_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"metadata": {
"count": 1,
"documentation": "https://developer.unbounce.com/api_reference/#id_page_groups__page_group_id__pages",
"location": "https://api.unbounce.com/sub_accounts/1552433/page_groups",
"related": {
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"page_groups": [
{
"id": "849893",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_page_groups__page_group_id__pages",
"related": {
"pages": "https://api.unbounce.com/page_groups/849893/pages",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Marketing Solutions"
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of form fields entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"page_groups" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a page group entity. Pages in this group can be found by following the link found in the metadata object.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "id", "metadata", "name" ],
"properties" : {
"id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata that can't be retrieved directly from a resource",
"type" : "object",
"required" : [ "documentation", "related" ],
"properties" : {
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "sub_account" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
}
}
}
}
}
}
get
/sub_accounts/{sub_account_id}/pages
Retrieve a list of all pages for a given sub-account.
Authentication Required
URI Parameters
sub_account_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"metadata": {
"count": 2,
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/sub_accounts/1552433/pages",
"related": {
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"pages": [
{
"created_at": "2015-12-16T00:59:29.000Z",
"domain": "unbouncepages.com",
"id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"last_published_at": "2015-12-16T01:02:23.000Z",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"related": {
"form_fields": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/form_fields",
"leads": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Forward Marketing Solutions",
"state": "published",
"sub_account_id": "1552433",
"url": "http://unbouncepages.com/forward-marketing-solutions/",
"variants_count": 0
},
{
"created_at": "2015-12-16T01:01:28.000Z",
"domain": "forward.corporatecole.com",
"id": "26d2a10b-4b00-495d-b915-978dc5b3565f",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f",
"related": {
"form_fields": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/form_fields",
"leads": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Mastering Leather E-Book",
"state": "unpublished",
"sub_account_id": "1552433",
"url": "http://forward.corporatecole.com/mastering-leather-e-book/",
"variants_count": 0
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of page entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"pages" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single page entity, which includes page statistics such as which variant is the winner or loser.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domain", "id", "integrations", "integrations_count", "integrations_errors_count", "metadata", "name", "state", "sub_account_id", "url", "variants_count" ],
"properties" : {
"integrations_count" : {
"type" : "integer"
},
"url" : {
"type" : "string",
"format" : "uri"
},
"sub_account_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"variants_count" : {
"type" : "integer"
},
"integrations_errors_count" : {
"type" : "integer"
},
"domain" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_fields", "leads", "sub_account" ],
"properties" : {
"form_fields" : {
"type" : "string",
"format" : "uri"
},
"leads" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"state" : {
"type" : "string",
"enum" : [ "unpublished", "published" ]
},
"tests" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a campaign experiment, aka a test.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "current" ],
"properties" : {
"current" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : false
}, {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
} ]
}
},
"definitions" : {
"empty_stats" : {
"type" : "object",
"additionalProperties" : false
},
"stats" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
}
}
},
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"last_published_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"integrations" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single integration entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "type", "errors_count" ],
"properties" : {
"type" : {
"type" : "string"
},
"errors_count" : {
"type" : "integer"
}
}
}
}
}
}
}
}
}
Domains
Customers can register custom domains with Unbounce, then publish pages to those domains.
get
/domains/{domain_id}
Retrieve a custom domain that has been registered with Unbounce.
Authentication Required
URI Parameters
domain_id
required string
Example Response
{
"id": "1225953",
"uuid": "9216b2e8-a57b-4b13-817b-24e53b55ac21",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_domains__domain_id_",
"location": "https://api.unbounce.com/domains/1225953",
"related": {
"account": "https://api.unbounce.com/accounts/1456243",
"pages": "https://api.unbounce.com/domains/1225953/pages",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "forward.corporatecole.com"
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single custom domain entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "id", "metadata", "name" ],
"properties" : {
"id" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "pages", "account", "sub_account" ],
"properties" : {
"pages" : {
"type" : "string",
"format" : "uri"
},
"account" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"name" : {
"type" : "string"
}
}
}
get
/domains/{domain_id}/pages
Retrieve a list of all pages based on the domain.
Authentication Required
URI Parameters
domain_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"metadata": {
"count": 1,
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/domains/1225953/pages",
"related": {
"domain": "https://api.unbounce.com/domains/1225953"
}
},
"pages": [
{
"created_at": "2015-12-16T01:01:28.000Z",
"domain": "forward.corporatecole.com",
"id": "26d2a10b-4b00-495d-b915-978dc5b3565f",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f",
"related": {
"form_fields": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/form_fields",
"leads": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Mastering Leather E-Book",
"state": "unpublished",
"sub_account_id": "1552433",
"url": "http://forward.corporatecole.com/mastering-leather-e-book/",
"variants_count": 0
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of page entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"pages" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single page entity, which includes page statistics such as which variant is the winner or loser.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domain", "id", "integrations", "integrations_count", "integrations_errors_count", "metadata", "name", "state", "sub_account_id", "url", "variants_count" ],
"properties" : {
"integrations_count" : {
"type" : "integer"
},
"url" : {
"type" : "string",
"format" : "uri"
},
"sub_account_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"variants_count" : {
"type" : "integer"
},
"integrations_errors_count" : {
"type" : "integer"
},
"domain" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_fields", "leads", "sub_account" ],
"properties" : {
"form_fields" : {
"type" : "string",
"format" : "uri"
},
"leads" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"state" : {
"type" : "string",
"enum" : [ "unpublished", "published" ]
},
"tests" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a campaign experiment, aka a test.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "current" ],
"properties" : {
"current" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : false
}, {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
} ]
}
},
"definitions" : {
"empty_stats" : {
"type" : "object",
"additionalProperties" : false
},
"stats" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
}
}
},
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"last_published_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"integrations" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single integration entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "type", "errors_count" ],
"properties" : {
"type" : {
"type" : "string"
},
"errors_count" : {
"type" : "integer"
}
}
}
}
}
}
}
}
}
Pages
Access all pages for the authenticated principal. An authenticated principal is either an API Key, or an OAuth client. We provide this top-level resource specifically for OAuth clients. Any Unbounce customer can be invited to author or view a page on a different client than their own. The legacy Pages resource we provide doesn't allow for accessing these external pages. This top-level resource allows you to additionally filter pages based on the specified role.
get
/pages
Retrieve a list of all pages.
Authentication Required
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100with_stats
booleanWhen true, include page stats for the collection.
Example: truerole
one of viewer, authorRestricts the scope of the returned pages.
Example: author
Example Response
{
"metadata": {
"count": 3,
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages"
},
"pages": [
{
"created_at": "2015-12-16T00:59:29.000Z",
"domain": "unbouncepages.com",
"id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"last_published_at": "2015-12-16T01:02:23.000Z",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"related": {
"form_fields": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/form_fields",
"leads": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Forward Marketing Solutions",
"state": "published",
"sub_account_id": "1552433",
"url": "http://unbouncepages.com/forward-marketing-solutions/",
"variants_count": 0
},
{
"created_at": "2015-12-16T01:01:28.000Z",
"domain": "forward.corporatecole.com",
"id": "26d2a10b-4b00-495d-b915-978dc5b3565f",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f",
"related": {
"form_fields": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/form_fields",
"leads": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Mastering Leather E-Book",
"state": "unpublished",
"sub_account_id": "1552433",
"url": "http://forward.corporatecole.com/mastering-leather-e-book/",
"variants_count": 0
},
{
"created_at": "2015-12-16T01:00:12.000Z",
"domain": "ubacademy.wpengine.com",
"id": "1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d",
"related": {
"form_fields": "https://api.unbounce.com/pages/1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d/form_fields",
"leads": "https://api.unbounce.com/pages/1db1f6cf-0ab1-4dc9-a2a9-57dc5c37f55d/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552463"
}
},
"name": "Lumber James E-Book",
"state": "unpublished",
"sub_account_id": "1552463",
"url": "http://ubacademy.wpengine.com/lumber-james-e-book/",
"variants_count": 0
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of page entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"pages" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single page entity, which includes page statistics such as which variant is the winner or loser.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domain", "id", "integrations", "integrations_count", "integrations_errors_count", "metadata", "name", "state", "sub_account_id", "url", "variants_count" ],
"properties" : {
"integrations_count" : {
"type" : "integer"
},
"url" : {
"type" : "string",
"format" : "uri"
},
"sub_account_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"variants_count" : {
"type" : "integer"
},
"integrations_errors_count" : {
"type" : "integer"
},
"domain" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_fields", "leads", "sub_account" ],
"properties" : {
"form_fields" : {
"type" : "string",
"format" : "uri"
},
"leads" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"state" : {
"type" : "string",
"enum" : [ "unpublished", "published" ]
},
"tests" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a campaign experiment, aka a test.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "current" ],
"properties" : {
"current" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : false
}, {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
} ]
}
},
"definitions" : {
"empty_stats" : {
"type" : "object",
"additionalProperties" : false
},
"stats" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
}
}
},
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"last_published_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"integrations" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single integration entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "type", "errors_count" ],
"properties" : {
"type" : {
"type" : "string"
},
"errors_count" : {
"type" : "integer"
}
}
}
}
}
}
}
}
}
get
/pages/{page_id}
Retrieve a single page.
Authentication Required
URI Parameters
page_id
required string
Example Response
{
"created_at": "2015-12-16T00:59:29.000Z",
"domain": "unbouncepages.com",
"id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"last_published_at": "2015-12-16T01:02:23.000Z",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"related": {
"form_fields": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/form_fields",
"leads": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Forward Marketing Solutions",
"state": "published",
"sub_account_id": "1552433",
"tests": {
"current": {
"champion": "a",
"clicks": 0,
"conversion_rate": 33.33,
"conversion_rate_delta": 0.0,
"conversions": 1,
"form_submits": 2,
"has_results": false,
"id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"losers": "",
"visitors": 3,
"visits": 3,
"winner": ""
}
},
"url": "http://unbouncepages.com/forward-marketing-solutions/",
"variants_count": 0
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single page entity, which includes page statistics such as which variant is the winner or loser.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domain", "id", "integrations", "integrations_count", "integrations_errors_count", "metadata", "name", "state", "sub_account_id", "url", "variants_count" ],
"properties" : {
"integrations_count" : {
"type" : "integer"
},
"url" : {
"type" : "string",
"format" : "uri"
},
"sub_account_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"variants_count" : {
"type" : "integer"
},
"integrations_errors_count" : {
"type" : "integer"
},
"domain" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_fields", "leads", "sub_account" ],
"properties" : {
"form_fields" : {
"type" : "string",
"format" : "uri"
},
"leads" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"state" : {
"type" : "string",
"enum" : [ "unpublished", "published" ]
},
"tests" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a campaign experiment, aka a test.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "current" ],
"properties" : {
"current" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : false
}, {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
} ]
}
},
"definitions" : {
"empty_stats" : {
"type" : "object",
"additionalProperties" : false
},
"stats" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
}
}
},
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"last_published_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"integrations" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single integration entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "type", "errors_count" ],
"properties" : {
"type" : {
"type" : "string"
},
"errors_count" : {
"type" : "integer"
}
}
}
}
}
}
get
/pages/{page_id}/form_fields
Retrieve a full list of all form fields across all page variants of a specific page.
Authentication Required
URI Parameters
page_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: trueinclude_sub_pages
booleanWhen true, include sub page form fields in the response
Example: true
Example Response
{
"form_fields": [
{
"id": "name",
"name": "Name",
"type": "text",
"validations": {
"required": false
}
},
{
"id": "email",
"name": "Email",
"type": "text",
"validations": {
"email": true,
"required": false
}
},
{
"id": "phone_number",
"name": "Phone Number",
"type": "text",
"validations": {
"phone": true,
"required": false
}
},
{
"id": "company",
"name": "Company",
"type": "text",
"validations": {
"required": false
}
}
],
"metadata": {
"count": 4,
"documentation": "https://developer.unbounce.com/api_reference/#id_pages__page_id__form_fields",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/form_fields",
"related": {
"page": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70"
}
}
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of form fields entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"form_fields" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single form field entity.",
"type" : "object",
"additionalProperties" : true,
"required" : [ "id", "name", "type" ],
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "text", "textarea", "checkbox", "radio", "hidden" ]
},
"options" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"validations" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "required" ],
"properties" : {
"required" : {
"type" : "boolean"
},
"email" : {
"type" : "boolean"
},
"phone" : {
"type" : "boolean"
}
}
}
}
}
},
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
}
}
}
get
/pages/{page_id}/leads
Retrieve a list of all leads for a given page (including AMP), pop-up, or sticky-bar.
Authentication Required
URI Parameters
page_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: descfrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"leads": [
{
"created_at": "2015-12-16T01:03:52.000Z",
"extra_data": {
"cookies": {
"hblid": [
"OiOij7R1Z7bwg9ot9B51W1IaCW0EQIN2"
],
"olfsk": "olfsk8370654808823019",
"ubvs": [
"38.88.7.981440778907332600"
],
"ubvt": [
"38.88.7.981440778907332600"
]
},
"request_id": "d7fa4e57-753d-4811-abc8-ad2f0dc742e1"
},
"form_data": {
"company": [
"Lumber James Canada"
],
"email": [
"james@lumberjames.com"
],
"name": [
"Lumber James"
],
"phone_number": [
"7785669522"
]
},
"id": "deadbeef-dead-beef-dead-beef00000075",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_leads__lead_id_",
"location": "https://api.unbounce.com/leads/deadbeef-dead-beef-dead-beef00000075",
"related": {
"page": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"page_id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"submitter_ip": "38.88.7.98",
"variant_id": "a"
},
{
"created_at": "2015-12-16T01:04:55.000Z",
"extra_data": {
"cookies": {
"hblid": [
"OiOij7R1Z7bwg9ot9B51W1IaCW0EQIN2"
],
"olfsk": "olfsk8370654808823019",
"ubvs": [
"38.88.7.981440778907332600"
],
"ubvt": [
"38.88.7.981440778907332600"
]
},
"request_id": "a2d1a185-7216-4749-b2f9-ca35c531cae4"
},
"form_data": {
"company": [
"Goingburger King"
],
"email": [
"arthur.goingburger@king.com"
],
"name": [
"Arthur Goingburger"
],
"phone_number": [
"7789563222"
]
},
"id": "deadbeef-dead-beef-dead-beef00000076",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_leads__lead_id_",
"location": "https://api.unbounce.com/leads/deadbeef-dead-beef-dead-beef00000076",
"related": {
"page": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"page_id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"submitter_ip": "38.88.7.98",
"variant_id": "a"
}
],
"metadata": {
"count": 2,
"documentation": "https://developer.unbounce.com/api_reference/#id_leads__lead_id_",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/leads",
"related": {
"page": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70"
}
}
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of leads entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"leads" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single lead entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "id", "extra_data", "form_data", "metadata", "page_id", "submitter_ip", "variant_id" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"extra_data" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"rapleaf" : {
"type" : "object"
},
"cookies" : {
"type" : "object"
},
"request_id" : {
"type" : "string"
},
"created_by" : {
"type" : "string",
"enum" : [ "api" ]
}
}
},
"form_data" : {
"type" : "object"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "page", "sub_account" ],
"properties" : {
"page" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"page_id" : {
"type" : "string"
},
"submitter_ip" : {
"type" : "string"
},
"variant_id" : {
"type" : "string"
}
}
}
},
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
}
}
}
post
/pages/{page_id}/leads
Create a new lead. New leads created via the API are marked distinctly from those created through the webapp. Leads created via the API will have a new attribute in their extra_data field:
{ 'created_by': 'api' }
Authentication Required
URI Parameters
page_id
required string
Example Request
{
"conversion": true,
"visitor_id": "127.0.0.123543254378923893",
"form_submission": {
"variant_id": "a",
"submitter_ip": "127.0.0.1",
"form_data": {
"first_name": "John",
"last_name": "Doe",
"email": "jqdoe@unbounce.com"
}
}
}
Request Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a new lead",
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_submission" ],
"properties" : {
"conversion" : {
"description" : "Whether this lead should be marked as having converted or not.",
"type" : "boolean"
},
"form_submission" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "variant_id", "submitter_ip", "form_data" ],
"properties" : {
"variant_id" : {
"description" : "The published page variant Id.",
"type" : "string"
},
"submitter_ip" : {
"description" : "Originating IP address of the lead.",
"type" : "string"
},
"form_data" : {
"description" : "Form fields and form values representing a lead.",
"type" : "object"
}
}
},
"visitor_id" : {
"description" : "Unbounce's internal visitor ID for tracking the lead.",
"type" : "string"
}
}
}
get
/pages/{page_id}/leads/{lead_id}
Get info of single Lead
Authentication Required
URI Parameters
page_id
required stringlead_id
required string
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single lead entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "id", "extra_data", "form_data", "metadata", "page_id", "submitter_ip", "variant_id" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"extra_data" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"rapleaf" : {
"type" : "object"
},
"cookies" : {
"type" : "object"
},
"request_id" : {
"type" : "string"
},
"created_by" : {
"type" : "string",
"enum" : [ "api" ]
}
}
},
"form_data" : {
"type" : "object"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "page", "sub_account" ],
"properties" : {
"page" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"page_id" : {
"type" : "string"
},
"submitter_ip" : {
"type" : "string"
},
"variant_id" : {
"type" : "string"
}
}
}
delete
/pages/{page_id}/leads/{lead_id}
Delete a single Lead. Only available to the account owner.
NOTE: this endpoint cannot be used with API keys (OAuth only)
Authentication Required
URI Parameters
page_id
required stringlead_id
required string
post
/pages/{page_id}/lead_deletion_request
Creates a request to asynchronously delete one or more leads for a given page.
To check the status of the request, perform a GET request using the response body's metadata.location (See Example Response).
This endpoint is only available to the account owner. Deleted leads cannot be recovered.
NOTE: this endpoint cannot be used with API keys (OAuth only)
Authentication Required
URI Parameters
page_id
required string
Example Request
{"lead_ids":["d07de003-6b3d-4603-bea2-3fc84075fc57"]}
Request Body Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description":
"Representation of a lead deletion request. Perform and create lead data deletion request. When all_leads is set and lead-ids are not provided, delete all leads of the page. When from ~ to datetime range is provided, only delete leads within the range.",
"type": "object",
"additionalProperties": false,
"properties": {
"lead_ids": {
"type": "array",
"description":
"A list of lead ids to be deleted. If the lead ID(s) do not exist for the requested page, missing leads are skipped and no error will be reported.",
"items": [
{
"type": "string"
}
]
},
"all_leads": {
"type": "boolean"
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
}
Example Response
{
"id": "97f0351b-2744-4155-9349-552fca447650",
"page_id": "9f01a369-642e-45ce-b342-b2d86746e7c4",
"created_by": "23fe757a-65bf-4506-9b41-5eb11c620d4f",
"created_at": "2018-10-11T21:36:14.433Z",
"total_leads_deleted": 0,
"status": "pending",
"query": { "lead_ids": ["d07de003-6b3d-4603-bea2-3fc84075fc57"] },
"completed_at": null,
"metadata": {
"location":
"https://api.unbounce.com/pages/9f01a369-642e-45ce-b342-b2d86746e7c4/lead_deletion_request/97f0351b-2744-4155-9349-552fca447650"
}
}
Response Body Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Representation of a lead deletion request.",
"type": "object",
"additionalProperties": true,
"required": ["id", "created_by", "created_at", "completed_at", "total_leads_deleted", "status", "metadata"],
"properties": {
"id": {
"type": "string"
},
"page_id": {
"type": "string"
},
"created_by": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": ["string", "null"],
"format": "date-time"
},
"total_leads_deleted": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["completed", "failed", "pending"]
},
"metadata": {
"type": "object",
"required": ["location"],
"properties": {
"location": {
"type": "string",
"format": "uri"
}
}
}
}
}
get
/pages/{page_id}/lead_deletion_request/{lead_deletion_request_id}
This endpoint is used to retrieve the status of a leads_deletion_request.
The status of the request can be found in the response body (see Example Response)
Authentication Required
URI Parameters
page_id
required stringlead_deletion_request_id
required string
Example Response
{
"id": "97f0351b-2744-4155-9349-552fca447650",
"page_id": "9f01a369-642e-45ce-b342-b2d86746e7c4",
"created_by": "23fe757a-65bf-4506-9b41-5eb11c620d4f",
"created_at": "2018-10-11T21:36:14.433Z",
"total_leads_deleted": 0,
"status": "pending",
"query": { "lead_ids": ["d07de003-6b3d-4603-bea2-3fc84075fc57"] },
"completed_at": null,
"metadata": {
"location":
"https://api.unbounce.com/pages/9f01a369-642e-45ce-b342-b2d86746e7c4/lead_deletion_request/97f0351b-2744-4155-9349-552fca447650"
}
}
Response Body Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Representation of a lead deletion request.",
"type": "object",
"additionalProperties": true,
"required": ["id", "created_by", "created_at", "completed_at", "total_leads_deleted", "status", "metadata"],
"properties": {
"id": {
"type": "string"
},
"page_id": {
"type": "string"
},
"created_by": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": ["string", "null"],
"format": "date-time"
},
"total_leads_deleted": {
"type": "number"
},
"status": {
"type": "string",
"enum": ["completed", "failed", "pending"]
},
"metadata": {
"type": "object",
"required": ["location"],
"properties": {
"location": {
"type": "string",
"format": "uri"
}
}
}
}
}
Page Groups
Pages may optionally be organized into groups. Each page group provides a link to the pages it contains in its meta data collection.
get
/page_groups/{page_group_id}/pages
Retrieve a list of all pages that belong to a given page group.
Authentication Required
URI Parameters
page_group_id
required string
Query Parameters
sort_order
one of asc, desc default: ascSort by creation date.
Example: desccount
booleanWhen true, don't return the response's collection attribute.
Example: truefrom
stringLimit results to those created after from.
Example: 2014-12-31T00:00:00.000Zto
stringLimit results to those created before to.
Example: 2014-12-31T23:59:59.999Zoffset
integerOmit the first offset number of results.
Example: 3limit
integer default: 50 maximum: 1000Only return limit number of results.
Example: 100
Example Response
{
"metadata": {
"count": 2,
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/page_groups/849893/pages",
"related": {
"page_group": "https://api.unbounce.com/sub_accounts/1552433/page_groups"
}
},
"pages": [
{
"created_at": "2015-12-16T00:59:29.000Z",
"domain": "unbouncepages.com",
"id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"last_published_at": "2015-12-16T01:02:23.000Z",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"related": {
"form_fields": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/form_fields",
"leads": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Forward Marketing Solutions",
"state": "published",
"sub_account_id": "1552433",
"url": "http://unbouncepages.com/forward-marketing-solutions/",
"variants_count": 0
},
{
"created_at": "2015-12-16T01:01:28.000Z",
"domain": "forward.corporatecole.com",
"id": "26d2a10b-4b00-495d-b915-978dc5b3565f",
"integrations": [],
"integrations_count": 0,
"integrations_errors_count": 0,
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_pages",
"location": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f",
"related": {
"form_fields": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/form_fields",
"leads": "https://api.unbounce.com/pages/26d2a10b-4b00-495d-b915-978dc5b3565f/leads",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"name": "Mastering Leather E-Book",
"state": "unpublished",
"sub_account_id": "1552433",
"url": "http://forward.corporatecole.com/mastering-leather-e-book/",
"variants_count": 0
}
]
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Collection of page entities.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "metadata" ],
"properties" : {
"metadata" : {
"title" : "Collection Metadata",
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "count" ],
"properties" : {
"count" : {
"type" : "integer"
}
}
} ]
},
"pages" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single page entity, which includes page statistics such as which variant is the winner or loser.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "domain", "id", "integrations", "integrations_count", "integrations_errors_count", "metadata", "name", "state", "sub_account_id", "url", "variants_count" ],
"properties" : {
"integrations_count" : {
"type" : "integer"
},
"url" : {
"type" : "string",
"format" : "uri"
},
"sub_account_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"variants_count" : {
"type" : "integer"
},
"integrations_errors_count" : {
"type" : "integer"
},
"domain" : {
"type" : "string"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "form_fields", "leads", "sub_account" ],
"properties" : {
"form_fields" : {
"type" : "string",
"format" : "uri"
},
"leads" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"state" : {
"type" : "string",
"enum" : [ "unpublished", "published" ]
},
"tests" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a campaign experiment, aka a test.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "current" ],
"properties" : {
"current" : {
"oneOf" : [ {
"type" : "object",
"additionalProperties" : false
}, {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
} ]
}
},
"definitions" : {
"empty_stats" : {
"type" : "object",
"additionalProperties" : false
},
"stats" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "champion", "clicks", "conversion_rate", "conversion_rate_delta", "conversions", "form_submits", "has_results", "id", "losers", "visitors", "visits", "winner" ],
"properties" : {
"form_submits" : {
"type" : "integer"
},
"visits" : {
"type" : "integer"
},
"conversion_rate" : {
"type" : "number"
},
"clicks" : {
"type" : "integer"
},
"id" : {
"type" : "string"
},
"conversions" : {
"type" : "integer"
},
"losers" : {
"type" : "string"
},
"has_results" : {
"type" : "boolean"
},
"winner" : {
"type" : "string"
},
"champion" : {
"type" : "string"
},
"visitors" : {
"type" : "integer"
},
"conversion_rate_delta" : {
"type" : "number"
}
}
}
}
},
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"last_published_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"integrations" : {
"type" : "array",
"minItems" : 0,
"uniqueItems" : true,
"items" : {
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single integration entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "type", "errors_count" ],
"properties" : {
"type" : {
"type" : "string"
},
"errors_count" : {
"type" : "integer"
}
}
}
}
}
}
}
}
}
Leads
There are two sets of data associated with each lead; the form data submitted when the lead was collected, and any optional extra data provided by 3rd party integrations with Unbounce (such as lead scoring or social data). Fields within the form data collection use a normalized form of the form field name.
get
/leads/{lead_id}
Retrieve a single lead.
Authentication Required
URI Parameters
lead_id
required string
Example Response
{
"created_at": "2015-12-16T01:03:52.000Z",
"extra_data": {},
"form_data": {
"company": [
"Lumber James Canada"
],
"email": [
"james@lumberjames.com"
],
"name": [
"Lumber James"
],
"phone_number": [
"7785669522"
]
},
"id": "deadbeef-dead-beef-dead-beef00000075",
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_leads__lead_id_",
"location": "https://api.unbounce.com/leads/deadbeef-dead-beef-dead-beef00000075",
"related": {
"page": "https://api.unbounce.com/pages/a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"sub_account": "https://api.unbounce.com/sub_accounts/1552433"
}
},
"page_id": "a0a3ffdf-5965-4ef2-8414-8afcded91f70",
"submitter_ip": "38.88.7.98",
"variant_id": "a"
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "Representation of a single lead entity.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "created_at", "id", "extra_data", "form_data", "metadata", "page_id", "submitter_ip", "variant_id" ],
"properties" : {
"created_at" : {
"title" : "Generic Date",
"description" : "RFC 5322, section 3.4.1, compliant date, which means formatted with: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"extra_data" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"rapleaf" : {
"type" : "object"
},
"cookies" : {
"type" : "object"
},
"request_id" : {
"type" : "string"
},
"created_by" : {
"type" : "string",
"enum" : [ "api" ]
}
}
},
"form_data" : {
"type" : "object"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "page", "sub_account" ],
"properties" : {
"page" : {
"type" : "string",
"format" : "uri"
},
"sub_account" : {
"type" : "string",
"format" : "uri"
}
}
}
}
} ]
},
"page_id" : {
"type" : "string"
},
"submitter_ip" : {
"type" : "string"
},
"variant_id" : {
"type" : "string"
}
}
}
Users
get
/users/self
Retrieve the current user.
Authentication Required
Example Response
{
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_users",
"location": "https://api.unbounce.com/users/1460053",
"related": {
"sub_accounts": [
"https://api.unbounce.com/sub_accounts/1552433",
"https://api.unbounce.com/sub_accounts/1552463"
],
"accounts": [
"https://api.unbounce.com/accounts/1456243"
]
}
},
"email": "corporate.cole@unbounce.com",
"first_name": "Corporate Cole",
"id": "1460053",
"last_name": "Enterprises"
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "User entity include accounts and sub-account data.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "id", "first_name", "last_name", "email", "metadata" ],
"properties" : {
"first_name" : {
"type" : "string"
},
"last_name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"email" : {
"type" : "string",
"format" : "email"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "accounts", "sub_accounts" ],
"properties" : {
"accounts" : {
"type" : "array",
"minItems" : 0,
"items" : {
"type" : "string",
"format" : "uri"
}
},
"sub_accounts" : {
"type" : "array",
"minItems" : 0,
"items" : {
"type" : "string",
"format" : "uri"
}
}
}
}
}
} ]
}
}
}
get
/users/{user_id}
Retrieves a particular user.
Authentication Required
URI Parameters
user_id
required string
Example Response
{
"metadata": {
"documentation": "https://developer.unbounce.com/api_reference/#id_users",
"location": "https://api.unbounce.com/users/1460053",
"related": {
"sub_accounts": [
"https://api.unbounce.com/sub_accounts/1552433",
"https://api.unbounce.com/sub_accounts/1552463"
],
"accounts": [
"https://api.unbounce.com/accounts/1456243"
]
}
},
"email": "corporate.cole@unbounce.com",
"first_name": "Corporate Cole",
"id": "1460053",
"last_name": "Enterprises"
}
Response Body Schema
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"description" : "User entity include accounts and sub-account data.",
"type" : "object",
"additionalProperties" : false,
"required" : [ "id", "first_name", "last_name", "email", "metadata" ],
"properties" : {
"first_name" : {
"type" : "string"
},
"last_name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"email" : {
"type" : "string",
"format" : "email"
},
"metadata" : {
"type" : "object",
"allOf" : [ {
"title" : "Entity Metadata",
"type" : "object",
"required" : [ "location", "documentation" ],
"properties" : {
"location" : {
"type" : "string",
"format" : "uri"
},
"documentation" : {
"type" : "string",
"format" : "uri"
},
"related" : {
"type" : "object"
}
}
}, {
"type" : "object",
"required" : [ "related" ],
"properties" : {
"related" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "accounts", "sub_accounts" ],
"properties" : {
"accounts" : {
"type" : "array",
"minItems" : 0,
"items" : {
"type" : "string",
"format" : "uri"
}
},
"sub_accounts" : {
"type" : "array",
"minItems" : 0,
"items" : {
"type" : "string",
"format" : "uri"
}
}
}
}
}
} ]
}
}
}