{"_id":"56898f1d5422830d0024ba8c","user":"547232594f5baa0800199200","version":{"_id":"5472329e4f5baa0800199204","__v":8,"project":"5472329e4f5baa0800199201","createdAt":"2014-11-23T19:16:46.915Z","releaseDate":"2014-11-23T19:16:46.915Z","categories":["5472329f4f5baa0800199205","54726e8c4f5baa0800199239","54727c3b4f5baa0800199249","54daa4b86606ea0d0057a60b","54dadc51ee3b8419007e4627","55685a846976ef0d0099c73c","556dc7ede24c5a0d007034f3","5644f242d608df0d00d269f3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"category":{"_id":"54727c3b4f5baa0800199249","pages":["56898f1d5422830d0024ba8c"],"project":"5472329e4f5baa0800199201","version":"5472329e4f5baa0800199204","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-24T00:30:51.036Z","from_sync":false,"order":3,"slug":"useriq-api","title":"UserIQ API"},"editedParams":true,"project":"5472329e4f5baa0800199201","__v":29,"editedParams2":true,"githubsync":"","updates":["5a8da52b8d847a0046b903e6"],"next":{"pages":[],"description":""},"createdAt":"2016-01-03T21:14:05.927Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"https://secure.useriq.com/api/1.1/campaign/reset?api_key=572d7372829a3211a73d9c2cb790ffe3&user_id=1234&c_id=9876","language":"http"}]},"results":{"codes":[]},"settings":"","method":"post","auth":"never","params":[{"_id":"56ae90195938fb0d00fdede3","ref":"","in":"body","required":false,"desc":"A valid, authorized UserIQ API access key.","default":"","type":"string","name":"api_key"},{"_id":"56ae90195938fb0d00fdede2","ref":"","in":"body","required":false,"desc":"The user_id of the user record to be updated with a campaign reset (Note: this should match the value passed in the UserIQ tracking code as 'user_id').","default":"","type":"string","name":"user_id"},{"_id":"56ae90195938fb0d00fdede1","ref":"","in":"body","required":false,"desc":"The UserIQ campaign ID","default":"","type":"string","name":"c_id"},{"_id":"56ae90195938fb0d00fdede0","ref":"","in":"body","required":false,"desc":"Redirect URL the user will be sent to","default":"","type":"string","name":"redirect"}],"url":"https://api.useriq.com/api/1.0/user_data/update"},"isReference":false,"order":1,"body":"The UserIQ Custom Data API gives development teams more control over attributes associated with users and accounts. The UserIQ Custom Data API is available to customers with a valid API access token. \n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"account_data/update\"\n}\n[/block]\nAdds/updates account attribute data for a specific account.\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/account_data/update\n\n**Resource Information**\nRequest Type: POST\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n1. **account_id (required)**\nThe account_id of the account to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'account_id').\n*Example:* 123\n\n2. **key (required)**\n**Description:** The name of the custom data attribute (this will show up in the list of user and/or account attributes when defining audience filters and segments).\n*Example:* 'account_subscription_level'\n\n3. **value (required)**\nThe value of the custom data attribute\n*Example:* 'Platinum'\n\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/account_data/update?account_id=1234&key=account_subscription_level&value=Platinum\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n** Example Result **\n{ \"result\":\"success\" }\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"user_data/update\"\n}\n[/block]\nAdds/updates user attribute data for a specific user.\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/user_data/update\n\n**Resource Information**\nRequest Type: POST\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n1. **user_id (required)**\nThe user_id of the user record to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'user_id').\n*Example:* 123\n\n2. **key (required)**\n**Description:** The name of the custom data attribute (this will show up in the list of user and/or account attributes when defining audience filters and segments).\n*Example:* 'account_subscription_level'\n\n3. **value (required)**\nThe value of the custom data attribute\n*Example:* 'Platinum'\n\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/user_data/update?user_id=1234&key=account_subscription_level&value=Platinum\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n** Example Result **\n{ \"result\":\"success\" }\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.\n\n[block:api-header]\n{\n  \"title\": \"user/update_bulk\"\n}\n[/block]\nAdds/updates user attribute data for multiple users and/or key-value pairs.\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/user/update_bulk\n\n**Resource Information**\nRequest Type: POST\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n**user_data (required)**\nThe array of user data to be updated in bulk. Each element in the array should include the following 3 fields:\n\n1. **user_id (required)**\nThe user_id of the user record to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'user_id').\n*Example:* 123\n\n2. **key (required)**\n**Description:** The name of the custom data attribute (this will show up in the list of user and/or account attributes when defining audience filters and segments).\n*Example:* 'account_subscription_level'\n\n3. **value (required)**\nThe value of the custom data attribute\n*Example:* 'Platinum'\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/user/bulk_update?user_data=[{\\\"user_id\\\":\\\"123\\\",\\\"key\\\":\\\"account_subscription_level\\\",\\\"value\\\":\\\"Platinum\\\"},{\\\"user_id\\\":\\\"456\\\",\\\"key\\\":\\\"account_subscription_level\\\",\\\"value\\\":\\\"Gold\\\"}]\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n** Example Result **\n{ \"result\":\"success\" }\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"campaign/reset_user\"\n}\n[/block]\nResets campaigns for a user so that they will be delivered again if filter criteria are met.\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/campaign/reset_user\n\n**Resource Information**\nRequest Type: POST\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n1. **user_id (required)**\nThe user_id of the user record to be updated with the campaign reset (Note: this should match the value passed in the UserIQ tracking code as 'user_id').\n*Example:* 123\n\n2. **c_id (required)**\n**Description:** The UserIQ campaign ID to be reset.\n*Example:* '9876'\n\n3. **redirect_url (optional)**\nThe URL that a user should be redirected to after the reset is complete\n*Example:* 'https%3A%2F%2Fgoogle.com%0A'\n\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/campaign/reset_user?user_id=1234&c_id=9876&redirect_url=https%3A%2F%2Fgoogle.com%0A\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n** Example Result **\n{ \"result\":\"success\" }\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"campaign/list\"\n}\n[/block]\nGet a list of campaigns for your site.\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/campaign/list\n\n**Resource Information**\nRequest Type: GET\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n1. **status (optional)**\n**Description:** The status of the campaigns you would like returned. If no *status* parameter is specified, we will return all campaigns for the site that are **not** Archived.\n*Possible values (case sensitive):*\n*Active*\n*Paused*\n*Preview*\n*Archived*\n\n2. **page_number (optional)**\n**Description:** The page number of results you would like to retrieve. We will return up to 100 results per page. DEFAULT: 1\n*Example:* 1\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/campaign/list\\nhttps://api.useriq.com/api/1.0/campaign/list?status=Active\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n** Example Result **\n{\n  \"results\": [\n    {\n      \"created_at\": \"2015-08-21T15:24:31Z\",\n      \"id\": 1111,\n      \"is_version_parent\": null,\n      \"name\": \"Home Page\",\n      \"status\": \"Preview\",\n      \"url_to_show_on\": \"http://mycompany.com/index.html\",\n      \"version_parent_id\": null,\n      \"version_segment_id\": null\n    },\n    {\n      \"created_at\": \"2015-09-1T21:45:07Z\",\n      \"id\": 1112,\n      \"is_version_parent\": null,\n      \"name\": \"Dashboard\",\n      \"status\": \"Paused\",\n      \"url_to_show_on\": \"http://mycompany.com/dashboard\",\n      \"version_parent_id\": null,\n      \"version_segment_id\": null\n    },\n    ...\n  ],\n  \"page\": 1,\n  \"results_per_page\": 33,\n  \"total_results\": 33\n}\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"campaign/search\"\n}\n[/block]\nGet a list of campaigns for your site that contain or match a query provided.\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/campaign/search\n\n**Resource Information**\nRequest Type: GET\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n1. **query (required)**\n**Description:** The string you would like to try and match to a campaign's name. This parameter is case insensitive.\n*Example:* my%20campaign\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/campaign/search\\nhttps://api.useriq.com/api/1.0/campaign/search?query=my%20campaign\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n** Example Result **\n{\n  \"results\": [\n    {\n      \"created_at\": \"2015-08-21T15:24:31Z\",\n      \"id\": 1111,\n      \"is_version_parent\": null,\n      \"name\": \"Home Page\",\n      \"status\": \"Preview\",\n      \"url_to_show_on\": \"http://mycompany.com/index.html\",\n      \"version_parent_id\": null,\n      \"version_segment_id\": null\n    },\n    ...\n  ]\n}\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"campaign/results\"\n}\n[/block]\nGets results for a given campaign provided. This endpoint provides an array of results in batches of 100. You can supply a page_number parameter to get additional results (see below).\n\n**Resource URL**\nhttps://api.useriq.com/api/1.0/campaign/results\n\n**Resource Information**\nRequest Type: POST\nResponse Format: JSON\n\n**Headers**\n\n1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page\n\n**Parameters**\n\n1. **c_id (required)**\n**Description:** The UserIQ campaign ID you would like to get results for.\n*Example:* 123\n\n2. **page_number (optional)**\n**Description:** The page number of results you would like to retrieve. We will return up to 100 results per page. DEFAULT: 1\n*Example:* 1\n\n\n**Example Request:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.useriq.com/api/1.0/campaign/results?c_id=9876\\n\\t-H\\n\\t\\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n** Example Result **\n{\n  \"results\": [{\n      \"action_taken\": \"completed\",\n      \"created_at\": \"2016-10-03T19:27:25Z\",\n      \"customer_user_id\": \"jwhitmer:::at:::omegafi.com\",\n      \"interaction\": null,\n      \"interaction_state\": null,\n      \"last_step_seen\": null,\n      \"updated_at\": \"2016-10-03T19:41:13Z\",\n      \"visitor_id\": \"8769448b3e90b14b\",\n      \"visitor_name\": \"\",\n      \"visitor_email\": \"\",\n      \"cvar1_name\": null,\n      \"cvar1_value\": null,\n      \"cvar2_name\": null,\n      \"cvar2_value\": null,\n      \"cvar3_name\": null,\n      \"cvar3_value\": null,\n      \"cvar4_name\": null,\n      \"cvar4_value\": null,\n      \"cvar5_name\": null,\n      \"cvar5_value\": null,\n      \"cvar6_name\": null,\n      \"cvar6_value\": null,\n      \"cvar7_name\": null,\n      \"cvar7_value\": null,\n      \"cvar8_name\": null,\n      \"cvar8_value\": null,\n      \"cvar9_name\": null,\n      \"cvar9_value\": null,\n      \"cvar10_name\": null,\n      \"cvar10_value\": null,\n      \"cvar11_name\": null,\n      \"cvar11_value\": null,\n      \"cvar12_name\": null,\n      \"cvar12_value\": null,\n      \"cvar13_name\": null,\n      \"cvar13_value\": null,\n      \"cvar14_name\": null,\n      \"cvar14_value\": null,\n      \"cvar15_name\": null,\n      \"cvar15_value\": null,\n      \"cvar16_name\": null,\n      \"cvar16_value\": null,\n      \"cvar17_name\": null,\n      \"cvar17_value\": null,\n      \"cvar18_name\": null,\n      \"cvar18_value\": null,\n      \"cvar19_name\": null,\n      \"cvar19_value\": null,\n      \"cvar20_name\": null,\n      \"cvar20_value\": null\n}, ...\n],\n  \"page\": 1,\n  \"results_per_page\": 100,\n  \"total_results\": 5429\n}\n\n** Response Codes **\n200: OK. Request processed successfully\n400: Bad Request. API request could not be understood by the server.\n401: Unauthorized. Invalid API access token.","excerpt":"","slug":"useriq-custom-data-api","type":"basic","title":"UserIQ Custom Data API"}

UserIQ Custom Data API


The UserIQ Custom Data API gives development teams more control over attributes associated with users and accounts. The UserIQ Custom Data API is available to customers with a valid API access token. [block:api-header] { "type": "post", "title": "account_data/update" } [/block] Adds/updates account attribute data for a specific account. **Resource URL** https://api.useriq.com/api/1.0/account_data/update **Resource Information** Request Type: POST Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** 1. **account_id (required)** The account_id of the account to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'account_id'). *Example:* 123 2. **key (required)** **Description:** The name of the custom data attribute (this will show up in the list of user and/or account attributes when defining audience filters and segments). *Example:* 'account_subscription_level' 3. **value (required)** The value of the custom data attribute *Example:* 'Platinum' **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/account_data/update?account_id=1234&key=account_subscription_level&value=Platinum\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "http" } ] } [/block] ** Example Result ** { "result":"success" } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token. [block:api-header] { "type": "post", "title": "user_data/update" } [/block] Adds/updates user attribute data for a specific user. **Resource URL** https://api.useriq.com/api/1.0/user_data/update **Resource Information** Request Type: POST Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** 1. **user_id (required)** The user_id of the user record to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'user_id'). *Example:* 123 2. **key (required)** **Description:** The name of the custom data attribute (this will show up in the list of user and/or account attributes when defining audience filters and segments). *Example:* 'account_subscription_level' 3. **value (required)** The value of the custom data attribute *Example:* 'Platinum' **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/user_data/update?user_id=1234&key=account_subscription_level&value=Platinum\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "http" } ] } [/block] ** Example Result ** { "result":"success" } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token. [block:api-header] { "title": "user/update_bulk" } [/block] Adds/updates user attribute data for multiple users and/or key-value pairs. **Resource URL** https://api.useriq.com/api/1.0/user/update_bulk **Resource Information** Request Type: POST Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** **user_data (required)** The array of user data to be updated in bulk. Each element in the array should include the following 3 fields: 1. **user_id (required)** The user_id of the user record to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'user_id'). *Example:* 123 2. **key (required)** **Description:** The name of the custom data attribute (this will show up in the list of user and/or account attributes when defining audience filters and segments). *Example:* 'account_subscription_level' 3. **value (required)** The value of the custom data attribute *Example:* 'Platinum' **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/user/bulk_update?user_data=[{\"user_id\":\"123\",\"key\":\"account_subscription_level\",\"value\":\"Platinum\"},{\"user_id\":\"456\",\"key\":\"account_subscription_level\",\"value\":\"Gold\"}]\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "http" } ] } [/block] ** Example Result ** { "result":"success" } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token. [block:api-header] { "type": "post", "title": "campaign/reset_user" } [/block] Resets campaigns for a user so that they will be delivered again if filter criteria are met. **Resource URL** https://api.useriq.com/api/1.0/campaign/reset_user **Resource Information** Request Type: POST Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** 1. **user_id (required)** The user_id of the user record to be updated with the campaign reset (Note: this should match the value passed in the UserIQ tracking code as 'user_id'). *Example:* 123 2. **c_id (required)** **Description:** The UserIQ campaign ID to be reset. *Example:* '9876' 3. **redirect_url (optional)** The URL that a user should be redirected to after the reset is complete *Example:* 'https%3A%2F%2Fgoogle.com%0A' **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/campaign/reset_user?user_id=1234&c_id=9876&redirect_url=https%3A%2F%2Fgoogle.com%0A\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "http" } ] } [/block] ** Example Result ** { "result":"success" } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token. [block:api-header] { "type": "get", "title": "campaign/list" } [/block] Get a list of campaigns for your site. **Resource URL** https://api.useriq.com/api/1.0/campaign/list **Resource Information** Request Type: GET Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** 1. **status (optional)** **Description:** The status of the campaigns you would like returned. If no *status* parameter is specified, we will return all campaigns for the site that are **not** Archived. *Possible values (case sensitive):* *Active* *Paused* *Preview* *Archived* 2. **page_number (optional)** **Description:** The page number of results you would like to retrieve. We will return up to 100 results per page. DEFAULT: 1 *Example:* 1 **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/campaign/list\nhttps://api.useriq.com/api/1.0/campaign/list?status=Active\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "text" } ] } [/block] ** Example Result ** { "results": [ { "created_at": "2015-08-21T15:24:31Z", "id": 1111, "is_version_parent": null, "name": "Home Page", "status": "Preview", "url_to_show_on": "http://mycompany.com/index.html", "version_parent_id": null, "version_segment_id": null }, { "created_at": "2015-09-1T21:45:07Z", "id": 1112, "is_version_parent": null, "name": "Dashboard", "status": "Paused", "url_to_show_on": "http://mycompany.com/dashboard", "version_parent_id": null, "version_segment_id": null }, ... ], "page": 1, "results_per_page": 33, "total_results": 33 } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token. [block:api-header] { "type": "get", "title": "campaign/search" } [/block] Get a list of campaigns for your site that contain or match a query provided. **Resource URL** https://api.useriq.com/api/1.0/campaign/search **Resource Information** Request Type: GET Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** 1. **query (required)** **Description:** The string you would like to try and match to a campaign's name. This parameter is case insensitive. *Example:* my%20campaign **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/campaign/search\nhttps://api.useriq.com/api/1.0/campaign/search?query=my%20campaign\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "text" } ] } [/block] ** Example Result ** { "results": [ { "created_at": "2015-08-21T15:24:31Z", "id": 1111, "is_version_parent": null, "name": "Home Page", "status": "Preview", "url_to_show_on": "http://mycompany.com/index.html", "version_parent_id": null, "version_segment_id": null }, ... ] } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token. [block:api-header] { "type": "get", "title": "campaign/results" } [/block] Gets results for a given campaign provided. This endpoint provides an array of results in batches of 100. You can supply a page_number parameter to get additional results (see below). **Resource URL** https://api.useriq.com/api/1.0/campaign/results **Resource Information** Request Type: POST Response Format: JSON **Headers** 1. **useriq-api-key (required)**: Your valid API key generated from the Site settings page **Parameters** 1. **c_id (required)** **Description:** The UserIQ campaign ID you would like to get results for. *Example:* 123 2. **page_number (optional)** **Description:** The page number of results you would like to retrieve. We will return up to 100 results per page. DEFAULT: 1 *Example:* 1 **Example Request:** [block:code] { "codes": [ { "code": "https://api.useriq.com/api/1.0/campaign/results?c_id=9876\n\t-H\n\t\tuseriq-api-key:572d7372829a3211a73d9c2cb790ffe3", "language": "http" } ] } [/block] ** Example Result ** { "results": [{ "action_taken": "completed", "created_at": "2016-10-03T19:27:25Z", "customer_user_id": "jwhitmer@omegafi.com", "interaction": null, "interaction_state": null, "last_step_seen": null, "updated_at": "2016-10-03T19:41:13Z", "visitor_id": "8769448b3e90b14b", "visitor_name": "", "visitor_email": "", "cvar1_name": null, "cvar1_value": null, "cvar2_name": null, "cvar2_value": null, "cvar3_name": null, "cvar3_value": null, "cvar4_name": null, "cvar4_value": null, "cvar5_name": null, "cvar5_value": null, "cvar6_name": null, "cvar6_value": null, "cvar7_name": null, "cvar7_value": null, "cvar8_name": null, "cvar8_value": null, "cvar9_name": null, "cvar9_value": null, "cvar10_name": null, "cvar10_value": null, "cvar11_name": null, "cvar11_value": null, "cvar12_name": null, "cvar12_value": null, "cvar13_name": null, "cvar13_value": null, "cvar14_name": null, "cvar14_value": null, "cvar15_name": null, "cvar15_value": null, "cvar16_name": null, "cvar16_value": null, "cvar17_name": null, "cvar17_value": null, "cvar18_name": null, "cvar18_value": null, "cvar19_name": null, "cvar19_value": null, "cvar20_name": null, "cvar20_value": null }, ... ], "page": 1, "results_per_page": 100, "total_results": 5429 } ** Response Codes ** 200: OK. Request processed successfully 400: Bad Request. API request could not be understood by the server. 401: Unauthorized. Invalid API access token.