{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/segments/:id","auth":"required","examples":{"codes":[{"code":"curl -X GET \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/segments/$ID\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"","language":"shell"}]},"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":"57ff82c78e087d0e000303f8"},{"name":"id","type":"string","default":"","desc":"Segment ID. It can be fetched using \"Segments: Get All (Index)\" endpoint.","required":true,"in":"path","ref":"","_id":"578911cdf55bf80e00d0c238"}],"results":{"codes":[{"code":"{\n  \"hidden\": false,\n  \"hidden_at\": null,\n  \"name\": \"first_name\",\n  \"id\": \"55f2f386636f6e34a4020000\",\n  \"users_count\": 5,\n  \"groups\": [\n    {\n      \"join_type\": \"+\",\n      \"rules\": [\n        {\n          \"time_frame\": \"\",\n          \"match_value_type\": \"\",\n          \"match_type\": \"equal\",\n          \"match_value\": \"michal\",\n          \"match_end_value\": \"\",\n          \"event_resource_type\": \"\",\n          \"event_resource_id\": \"\",\n          \"type\": \"first_name\",\n          \"in_app_event_name\": \"\",\n          \"locations\": null\n        }\n      ]\n    }\n  ]\n}","name":"","status":200,"language":"json"}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Segments: Get One (Show)","type":"endpoint","slug":"segments-get-one","excerpt":"Get the parameters of a single segment","body":"","updates":[],"order":52,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28dd","githubsync":"","createdAt":"2016-07-15T16:39:41.824Z","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"},"editedParams2":true,"parentDoc":null,"user":"577cf7765fd4de0e00cc3d50","__v":4,"editedParams":true,"project":"54aa7f773b56130b0056c86e","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"}}

getSegments: Get One (Show)

Get the parameters of a single segment

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
Segment ID. It can be fetched using "Segments: Get All (Index)" endpoint.

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 }}