User.com REST API Docs

# List all user segments

You can return a list with all of your users’ segments. Use a returned URL to list all users added to the segment.

GET /segments/

# Request

  • CURL
  • JavaScript
  • PHP
  • Python 
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2"
"https://<your_app_subdomain>.user.com/api/public/segments/"

# Response

{
  "previous": null,
  "results": [
    {
      "name": "Active",
      "description": "Users who have visited your website at least once in the last 30 days.",
      "users": "https://<your_app_subdomain>.user.com/api/public/segments/1033/users/",
      "id": 1033,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    },
    {
      "name": "New",
      "description": "Users who have visited your website for the first time in the last 24 hours.",
      "users": "https://<your_app_subdomain>.user.com/api/public/segments/1034/users/",
      "id": 1034,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    },
    {
      "name": "New with email",
      "description": "Users who first visited your website in the last 24 hours and have provided an email address.",
      "users": "https://<your_app_subdomain>.user.com/api/public/segments/1037/users/",
      "id": 1037,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    },
    {
      "name": "With email",
      "description": "Users whose email address you have.",
      "users": "https://<your_app_subdomain>.user.com/api/public/segments/1036/users/",
      "id": 1036,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    },
    {
      "name": "Slipping away",
      "description": "Users who have not visited your page within the last 30 days.",
      "users": "https://<your_app_subdomain>.user.com/api/public/segments/1035/users/",
      "id": 1035,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    }
  ],
  "next": null,
  "count": 5
}

← View deal segment →