{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/segments/rules","auth":"required","examples":{"codes":[{"code":"curl -X GET \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/segments/rules\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"","name":"","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":"57ff82aec135231700aed82a"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"rules\": [\n    {\n      \"type\": \"email\",\n      \"data_type\": \"string\",\n      \"match_types\": [\n        \"equal\",\n        \"not_equal\",\n        \"starts_with\",\n        \"ends_with\",\n        \"contains\"\n      ]\n    },\n    {\n      \"type\": \"first_name\",\n      \"data_type\": \"string\",\n      \"match_types\": [\n        \"equal\",\n        \"not_equal\",\n        \"starts_with\",\n        \"ends_with\",\n        \"contains\"\n      ]\n    }\n]","name":""}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Segments: Get Available Rules","type":"endpoint","slug":"segments-fetch-available-rules","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Rules\",\n  \"body\": \"Rules specify what matching options are available for segment creation. The list of available rules can grow, when custom tags are added through SDK, or Service Sync.\"\n}\n[/block]","updates":[],"order":52,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28cc","__v":5,"createdAt":"2015-11-18T09:58:33.376Z","user":"54aa7f3f9bb00c0b00cb899b","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"},"githubsync":"","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"},"parentDoc":null,"project":"54aa7f773b56130b0056c86e"}

getSegments: Get Available Rules


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.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Rules", "body": "Rules specify what matching options are available for segment creation. The list of available rules can grow, when custom tags are added through SDK, or Service Sync." } [/block]

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