{"_id":"564c4bc9b9cdb41700a0eae7","__v":5,"user":"54aa7f3f9bb00c0b00cb899b","category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"githubsync":"","version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"parentDoc":null,"project":"54aa7f773b56130b0056c86e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-18T09:58:33.376Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"shell","name":"","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\""}]},"method":"get","results":{"codes":[{"name":"","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]","language":"json","status":200}]},"settings":"564bbbf80cbcc91700b8171c","auth":"required","params":[{"_id":"57ff82aec135231700aed82a","ref":"","in":"path","required":true,"desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","default":"","type":"string","name":"app_id"}],"url":"/apps/:app_id/segments/rules"},"isReference":true,"order":49,"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]","excerpt":"","slug":"segments-fetch-available-rules","type":"endpoint","title":"Segments: Get Available Rules"}

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