How Can We Help?

Articles in this section

UserIQ Custom Data APIs

Avatar
Sashank Gogineni
  • Updated
Follow

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.

post account/update

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:

HTTP

https://api.useriq.com/api/1.0/account_data/update?account_id=1234&key=account_subscription_level&value=Platinum
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

post user/update

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:

HTTP
https://api.useriq.com/api/1.0/user_data/update?user_id=1234&key=account_subscription_level&value=Platinum
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

user/update_bulk

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. There is a limit of 500 elements in the user_data array. 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:

HTTP
https://api.useriq.com/api/1.0/user/update_bulk?user_data=[{"user_id":"123","key":"account_subscription_level","value":"Platinum"},{"user_id":"456","key":"account_subscription_level","value":"Gold"}]
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

post campaign/reset_user

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:

HTTP
https://api.useriq.com/api/1.0/campaign/reset_user?user_id=1234&c_id=9876&redirect_url=https%3A%2F%2Fgoogle.com%0A
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

get campaign/list

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:

Text
https://api.useriq.com/api/1.0/campaign/list
https://api.useriq.com/api/1.0/campaign/list?status=Active
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

get campaign/search

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:

Text
https://api.useriq.com/api/1.0/campaign/search
https://api.useriq.com/api/1.0/campaign/search?query=my%20campaign
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

get campaign/results

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:

HTTP
https://api.useriq.com/api/1.0/campaign/results?c_id=9876
  -H
    useriq-api-key:572d7372829a3211a73d9c2cb790ffe3

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.

Related articles

Comments

0 comments

Please sign in to leave a comment.