{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/campaigns/:id/users","auth":"required","settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"language":"shell","code":"curl -X GET \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/campaigns/$ID/users\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\""}]},"method":"get","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff8143159c7e0e003c4821"},{"name":"id","type":"string","default":"","desc":"Campaign ID. It can be fetched by \"Campaigns: Get All (Index)\" endpoint.","required":true,"in":"path","ref":"","_id":"57d131308cad9c1700a98f67"},{"name":"page","type":"string","default":"1","desc":"page of the users results","required":false,"in":"path","ref":"","_id":"5e734849d6927f00653a8201"},{"name":"per_page","type":"string","default":"1000","desc":"how many users per page should be returned. Can't be more then 1000.","required":false,"in":"path","ref":"","_id":"5e734849d6927f00653a8200"},{"name":"from","type":"string","default":"","desc":"Date from when users got campaign, acceptable format date : YYYY-MM-DD or DD-MM-YYYY","required":false,"in":"path","ref":"","_id":"5fc61ada9825da001169e1d9"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"users\": [\n        {\n            \"age\": 20,\n            \"alias\": \"sample_alias\",\n            \"firstName\": \"sample_name\",\n            \"gender\": \"male\",\n            \"lastName\": \"sample_name\",\n            \"sample_custom_attribute\": \"sample_custom_attribute_value\",\n            \"sents\": [\n                \"2020-03-18T14:04:35+00:00\"\n            ],\n            \"opens\": [],\n            \"impressions\": [],\n            \"clicks\": [],\n            \"id\": \"sample_user_id\"\n        }\n    ],\n    \"control_group\": [\n        {\n            \"age\": 22,\n            \"alias\": \"other_alias\",\n            \"firstName\": \"other_name\",\n            \"gender\": \"male\",\n            \"lastName\": \"other_name\",\n            \"sample_custom_attribute\": \"sample_custom_attribute_value\",\n            \"id\": \"other_user_id\"\n        }\n    ]\n}","name":""}]}},"next":{"description":"","pages":[]},"title":"Campaigns: Get Users","type":"endpoint","slug":"campaigns-get-users","excerpt":"","body":"","updates":[],"order":16,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e734849d6927f00653a81ff","createdAt":"2020-03-19T10:24:09.879Z","user":"5874dcd9edcf9f2f00f9e0af","category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"project":"54aa7f773b56130b0056c86e","__v":5,"parentDoc":null}

getCampaigns: Get Users


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.
id:
required
string
Campaign ID. It can be fetched by "Campaigns: Get All (Index)" endpoint.
page:
string1
page of the users results
per_page:
string1000
how many users per page should be returned. Can't be more then 1000.
from:
string
Date from when users got campaign, acceptable format date : YYYY-MM-DD or DD-MM-YYYY

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}