Skip to main content
In the HTTP Response for Listing and Showing Alert Groups, the full list of matching Experiences are returned as the experiences key.

​
Schema

PropertyTypeDescription
idIDThe Chameleon ID
created_attimestampWhen this happened or when this was added to the Database
updated_attimestampThe last time any property was updated
namestringThe name given by an administrator of Chameleon
kindstringThe kind of matched Experiences for this Alert Group. More info ↓: One of all, tour, survey, tags, or campaigns
intervalnumber# of days that the alerting condition should wait before triggering a violation
published_attimestampThe time this was most recently published
stylestringThe style of alert condition to evaluate. More info ↓: One of unseen or uncompleted
last_notified_attimestampLast time this alert was triggered for any Experience
tag_idsarrayWhen kind=tags, the IDs of the Tags that Experiences must be tagged with to be included in this Alert Group
campaign_idsarrayWhen kind=campaigns, the IDs of the Experiences to be included in this Alert Group
slack_uidstringThe Slack channel ID to notify on, only when opt_in_slack_at has a value
opt_in_slack_attimestampWhether or not to send triggered alerts to Slack on the slack_uid channel
emailsarrayThe email address(es) to message, only when opt_in_email_at has a value
opt_in_email_attimestampWhether or not to send triggered alerts to the given list of emails
Kinds of Alert Groups (kind property)
An Alert Group creates a dynamic or static group of Experiences. Each experience is checked for violation of the alert conditions.
Kind-Description
alldynamicAll currently published Tours + Microsurveys
tourdynamicAll published Tours
surveydynamicAll published Microsurveys
tagsdynamicAll published Tours + Microsurveys with any of the specified Tags in the tag_ids list
campaignsstaticAll published Tours + Microsurveys explicitly in the campaign_ids list
Alerting conditions (style property)
Kind-Description
unseen-An Experience that is not Seen (i.e. displayed to any User) during the interval # of days will trigger an alert.
uncompleted-An Experience that is not Completed (i.e. no User finished) during the interval # of days will trigger an alert.

​
Listing Alert Groups

Retrieve a list of all Alert Groups and all currently matching Experiences. An account typically has 1-5 Alert Groups so this response should be relatively small.

​
HTTP Request

GET https://api.chameleon.io/v3/edit/alert_groups

​
HTTP Response

{
  "alert_groups": [
    {
      "id": "5f3c4232c712de665632a6e2",
      "name": "Research opportunities flow (at least 1 per 2 weeks)",
      "interval": 14,
      "style": "uncompleted",
      "kind": "campaigns",
      "campaign_ids": [
        "5f3c4232c712de665632a6d5",
        "5f3c4232c712de665632a2a3"
      ],
      ...
      "experiences": [
        {
          "id": "5f3c4232c712de665632a6d5",
          "name": "Research: Planed New Feature X",
          ...
        },
        {
          "id": "5f3c4232c712de665632a2a3",
          "name": "Research: New Feature Z",
          ...
        }
      ],
    },
    {
      "id": "5f3c4232c712de665632a6e1",
      "name": "Any Tour/Microsurvey that goes 1 week without a completion",
      "interval": 7,
      "style": "uncompleted",
      "kind": "all",
      ...
      "experiences": [
        ...
      ]
    },
    {
      "id": "5f3c4232c712de665632a6d8",
      "name": "Broken Feature announcements (1 day not Seen)",
      "interval": 1,
      "style": "unseen",
      "kind": "tags",
      "tag_ids": [
        "5f3c4232c712de665632a5d7",
        "5f3c4232c712de665632aa3b"
      ],
      ...
      "experiences": [
        ...
      ]
    },
    ...
  ]
}

​
Showing a Alert Group

Retrieve a single Alert Group and all currently matching Experiences.

​
HTTP Request

param-description
idrequiredAn Alert Group ID to lookup
GET https://api.chameleon.io/v3/edit/alert_groups/:id

​
HTTP Response

{
  "alert_group": {
    "id": "5f3c4232c712de665632a6e2",
    "name": "Research opportunities flow (at least 1 per 2 weeks)",
    "interval": 14,
    "style": "uncompleted",
    "kind": "campaigns",
    "campaign_ids": [
      "5f3c4232c712de665632a6d5",
      "5f3c4232c712de665632a2a3"
    ],
    "experiences": [
      {
        "id": "5f3c4232c712de665632a6d5",
        "name": "Research: Planed New Feature X",
        ...
      },
      {
        "id": "5f3c4232c712de665632a2a3",
        "name": "Research: New Feature Z",
        ...
      }
    ],
    ...
  }
}