curl -H "X-Account-Secret: ACCOUNT_SECRET" https://api.chameleon.io/... — see the pages below for more info
UseCurrently, our REST API supports the following endpoints:https://api.chameleon.ioorhttps://api.trychameleon.comfor all requests to the Chameleon API (either will work but usechameleon.iofor new projects.)
| Model + details | List URL | Show URL |
|---|---|---|
| User Profiles | GET /v3/analyze/profiles | GET v3/analyze/profiles/:id |
| Companies | GET /v3/analyze/companies | GET v3/analyze/companies/:id |
| Segments | GET /v3/edit/segments | GET /v3/edit/segments/:id |
| Tours | GET /v3/edit/tours | GET /v3/edit/tours/:id |
| Tour Interactions | GET /v3/analyze/interactions | GET /v3/analyze/interactions/:id |
| Microsurveys | GET /v3/edit/surveys | GET /v3/edit/surveys/:id |
| Microsurvey Responses | GET /v3/analyze/responses | - |
| Experience Deliveries | GET /v3/edit/deliveries | GET /v3/edit/delivery/:id |
| Rate Limit Groups | GET /v3/edit/limit_groups | GET v3/edit/limit_groups/:id |
| Alert Groups | GET /v3/edit/alert_groups | GET v3/edit/alert_groups/:id |
| Launchers | GET /v3/edit/launchers | GET /v3/edit/launchers/:id |
| Tooltips | GET /v3/edit/tooltips | GET /v3/edit/tooltips/:id |
| Webhooks | GET /v3/edit/webhooks | GET v3/edit/webhooks/:id |
| Domains | GET /v3/edit/urls | GET /v3/edit/urls/:id |
| Tags | GET /v3/edit/tags | GET v3/edit/tags/:id |
| Data Properties | GET /v3/edit/properties | GET /v3/edit/properties/:id |
| Data Imports | GET /v3/edit/imports | GET /v3/edit/imports/:id |
Ideas for how you can use this API
Chameleon’s REST API is made to be adaptable to your own custom use cases. Nevertheless, there are some cases where you might want to use it:- Import data (via CSV) on a one-time or recurring basis.
- Register a Webhook to receive realtime notifications of Microsurvey Responses.
- Use the Microsurveys Endpoint to download Microsurvey Response data periodically.
- Get a list of all the User data being sent to Chameleon and manipulate it (delete, update, etc.) through the User Profiles Endpoint.
- Use an Alert Group to alert when Experiences aren’t completed in a specific amount of time.
- Monitor the Experiences assigned to your Rate Limit Groups.
- Trigger an Experience via REST API that will run on next page load via Experience Deliveries.
If there is any use case where you’d like to use our API but you’re not sure how, feel free to Contact us.