{"info":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","description":"

This is Chattermill's official REST API. You can use it to add or update responses on Chattermill or query your data on Chattermill.

Authentication

You need to provide an API Key for every request. You can get your API Key here. The key should be provided in the Authorization header:

curl 'https://api.chattermill.com/v1/projects' \\\n        -H 'Authorization: Bearer {key}'\n\n

Data Structure

Your main data model in Chattermill is Response. Once processed, this object contains the comment, score, any meta-data, and the themes.

You may have several projects on Chattermill, so you would need to specify a Project when querying other data in the URL.

You also have several datasets characterised by different data_types (think nps, review etc.) and data_sources (Zendesk, Typeform etc.). These can be handy if you need to work with only one group of responses.

We currently provide only read endpoints for Projects, Data Types and Data Sources.

Typical Workflows

Fetching new responses

You will probably need to query the /projects endpoint first to find the key of the project you need. Typically, this is similar to a lowercase version of your company's name.

Once you have that, you can query the /responses endpoint specifying the right group of filters. We recommend scoping by a specific date range based on how often your workflow runs (e.g. previous day or previous hour) or storing the last processed id and scrolling through the pages until you hit it.

Adding feedback to Chattermill

You will probably need to query the /projects endpoint first to find the key of the project you need. Typically, this is similar to a lowercase version of your company's name.

Then query /data_sources and /data_types endpoints to get the keys for those variables. If the correct sources or types do not exist, please contact our Support team to create them.
Finally, you would need to send a POST request to the /responses endpoint.

\n\n

Typically, Chattermill will not store your users' PII data, meaning there is no GDPR liability. However, if you need to delete a specific Response, you can find it by any response attribute (e.g. email or customer ID) through the /responses/search endpoint and then trigger permanent deletion through the DELETE /responses/{id} endpoint

Enriching Chattermill Data

Frequently, you will want to add additional attributes (aka enrich) to the data you already have in Chattermill, perhaps from your CRM or your own database / data warehouse.

To do this, we recommend one of two approaches:

Periodically poll for new responses using the GET /responses endpoint, using filters to only find new data (either by maintaining an ID-based or date-based cursor on your end or by using filters to find responses without the attribute in question. Then, when a response needs to be enriched, use the PUT /responses/{id} endpoint to add the attribute.
\n
Set up a Webhook on Chattermill Workflows to receive an automated notification for new responses, then update them using the PUT /responses/{id} endpoint
\n

An anti-pattern that should be avoided is using POST responses/search endpoint to find a given response and then update it. This can lead to unpredictable results because the response might not have been fully processed when you kick off your workflow. The approaches above ensure consistency.

Getting Help

Please get in touch via api@chattermill.com if you have any questions. We will reply quickly.

\n\n

Please let us know if you are an API user, so we can send you any updates relevant to API users. No SPAM. Sign up here.

Resources

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Data Structure","slug":"data-structure"},{"content":"Typical Workflows","slug":"typical-workflows"},{"content":"Getting Help","slug":"getting-help"},{"content":"API Update Newsletter","slug":"api-update-newsletter"},{"content":"Resources","slug":"resources"}],"owner":"957224","collectionId":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","publishedId":"7TT8V8s","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-14T18:21:06.000Z"},"item":[{"name":"Projects","item":[{"name":"Get a Project by Project ID","id":"87b2d288-e82c-d3fc-9eb7-880c70228c37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/projects/:id","description":"

Returns a single Project

[Required] id of Project to fetch

\n","type":"text/plain"},"type":"string","value":"{{id}}","key":"id"}]}},"response":[{"id":"7b0009a8-7ef6-4ea1-9348-8fd402ada899","name":"Get a Project by Project ID","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.chattermill.com/v1/projects/:id","protocol":"https","host":["api","chattermill","com"],"path":["v1","projects",":id"],"variable":[{"key":"id","value":"{{id}}","type":"string","description":"[Required] `id` of Project to fetch"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"project\": {\n \"id\": 121435353423462,\n \"name\": \"Project One\",\n \"key\": \"project_one\"\n}"}],"_postman_id":"87b2d288-e82c-d3fc-9eb7-880c70228c37"},{"name":"Get a list of Projects","id":"7f997b0f-4d81-9834-4bb2-3bd1e1a35dcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/projects","description":"

Returns all projects the user has access to

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","projects"],"host":["api","chattermill","com"],"query":[],"variable":[]}},"response":[{"id":"6e87fb90-c0f2-4db6-b33b-9f4001f409dc","name":"Get a list of Projects","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/projects"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"projects\": [\n {\n \"id\": 232324435353,\n \"key\": \"project_one\",\n \"name\": \"Project One\"\n },\n {\n \"id\": 134532323232,\n \"key\": \"project_two\",\n \"name\": \"Project Two\"\n }\n ]\n}"}],"_postman_id":"7f997b0f-4d81-9834-4bb2-3bd1e1a35dcb"}],"id":"4e902824-e1f9-cb0a-e2a0-e2fab2d1ac7a","description":"

Operations related to Projects

\n","event":[{"listen":"prerequest","script":{"id":"806d72a6-a6fa-4d1c-8508-227c932148a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"157f5a9e-b2fa-4975-8b1b-e49d4970b9a9","type":"text/javascript","exec":[""]}}],"_postman_id":"4e902824-e1f9-cb0a-e2a0-e2fab2d1ac7a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Responses","item":[{"name":"Get a Response by ID","id":"ace8b4a6-4e39-a1d2-e443-2ed1f10cd589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/responses/:id","description":"

Returns a single response

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"},{"description":{"content":"

[Required] id of Response to fetch

\n","type":"text/plain"},"type":"string","value":"{{id}}","key":"id"}]}},"response":[{"id":"9ee1f30d-51a2-4407-b5ee-0a5c859a18d8","name":"Get a Response by ID","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.chattermill.com/v1/:project/responses/:id","protocol":"https","host":["api","chattermill","com"],"path":["v1",":project","responses",":id"],"variable":[{"key":"project","value":"{{project}}","type":"string","description":"[Required] Project `key` to fetch responses from (can be obtained from List Projects endpoint)"},{"key":"id","value":"{{id}}","type":"string","description":"[Required] `id` of Response to fetch"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"id\": 12345678901234567890,\n \"score\": 10,\n \"comment\": \"Example Comment\",\n \"original_comment\": \"Example Comment\",\n \"created_at\": \"2023-03-15T10:28:50.077Z\",\n \"updated_at\": \"2023-03-17T08:40:09.525Z\",\n \"user_attributes\": {\n \"name\": {\n \"name\": \"Name\",\n \"value\": \"James Bond\"\n },\n \"site\": {\n \"name\": \"Site\",\n \"value\": \"UK\"\n },\n \"order\": {\n \"name\": \"Order ID\",\n \"value\": \"007\"\n }\n },\n \"themes\": [\n {\n \"name\": \"Example Theme\",\n \"id\": 1,\n \"parent_id\": 2,\n \"sentiment\": -1,\n \"parent\": \"Example Category\"\n }\n ],\n \"phrases\": [\n {\n \"label\": \"example_phrase\",\n \"parent\": \"example_phrase_cluster\",\n \"sentiment\": -1.0\n }\n ]\n }\n}"}],"_postman_id":"ace8b4a6-4e39-a1d2-e443-2ed1f10cd589"},{"name":"Update a Response by Response ID","id":"a632c60d-ccda-74b3-b9e7-b5a0c4917e1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"response\": {\n\t \"user_meta\": {\n\t \"customer_id\": {\n\t \"type\": \"text\",\n\t \"value\": \"1234\",\n\t \"name\": \"Customer ID\"\n\t }\n\t },\n\t \"segments\": {\n\t \"customer_type\": {\n\t \"type\": \"text\",\n\t \"value\": \"New\",\n\t \"name\": \"Customer Type\"\n\t }\n\t }\n\t}\n}"},"url":"https://api.chattermill.com/api/v1/:project/responses/:response_id","description":"

Update response with attributes given

[Required] Project key to update responses in (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"","key":"project"},{"description":{"content":"

[Required] id of Project to update

\n","type":"text/plain"},"type":"string","value":"","key":"response_id"}]}},"response":[],"_postman_id":"a632c60d-ccda-74b3-b9e7-b5a0c4917e1a"},{"name":"Destroy a Response by Response ID","id":"2ee9642d-201b-4b41-be9b-ecbe5437694f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://api.chattermill.io/v1/:project/responses/:response_id","description":"

Permanently delete a response with a given ID.

Please note, this operation is not reversible and should thus only be utilised for automating data erasure requests in tandem with a /search call to find the correct Response ID (for example to comply with GDPR).

[Required] Project key to update responses in (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"","key":"project"},{"description":{"content":"

[Required] id of Project to update

\n","type":"text/plain"},"type":"string","value":"","key":"response_id"}]}},"response":[],"_postman_id":"2ee9642d-201b-4b41-be9b-ecbe5437694f"},{"name":"Get a list of Responses for a project","id":"3dd30375-7956-b872-edbd-873eef126b2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/responses?page={{page}}&per_page={{per_page}}&from={{from}}&to={{to}}&data_type={{data_type}}&data_source={{data_source}}&filter_property={{filter_property}}&filter_value={{filter_value}}&text_analytics_processed={{text_analytics_processed}}&comment_present={{comment_present}}&score_from={{score_from}}&score_to={{score_to}}&custom_segment_id={{custome_segment_id}}&theme_id={{theme_id}}&updated_from={{updated_from}}&updated_to={{updated_to}}","description":"

Returns a paginated collection of responses

[Optional] Results page requested (defaults to 1)

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

[Optional] # of results per page (defaults to 20, max. 100)

\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"},{"description":{"content":"

[Optional] Date From to filter by (YYYYMMDD_HHMMSS format)

\n","type":"text/plain"},"key":"from","value":"{{from}}"},{"description":{"content":"

[Optional] Date to to filter by (YYYYMMDD_HHMMSS format)

\n","type":"text/plain"},"key":"to","value":"{{to}}"},{"description":{"content":"

[Optional] Data Type key to filter by (can be obtained via List Data Types endpoint)

\n","type":"text/plain"},"key":"data_type","value":"{{data_type}}"},{"description":{"content":"

[Optional] Data Source key to filter by (can be obtained via List Data Sources endpoint

\n","type":"text/plain"},"key":"data_source","value":"{{data_source}}"},{"description":{"content":"

[Optional] Segment property to filter by

\n","type":"text/plain"},"key":"filter_property","value":"{{filter_property}}"},{"description":{"content":"

[Optional] Segment value to filter by

\n","type":"text/plain"},"key":"filter_value","value":"{{filter_value}}"},{"description":{"content":"

[Optional] Set to true to only fetch responses that were processed by machine learning model (by default both processed and unprocessed responses will be returned).

\n","type":"text/plain"},"key":"text_analytics_processed","value":"{{text_analytics_processed}}"},{"description":{"content":"

[Optional] Set to true to only fetch responses with a comment (false by default).

\n","type":"text/plain"},"key":"comment_present","value":"{{comment_present}}"},{"description":{"content":"

[Optional] Score From to filter by (defaults to 0)

\n","type":"text/plain"},"key":"score_from","value":"{{score_from}}"},{"description":{"content":"

[Optional] Score To to filter by (defaults to 10)

\n","type":"text/plain"},"key":"score_to","value":"{{score_to}}"},{"description":{"content":"

[Optional] Choose a Custom Segment to filter by

\n","type":"text/plain"},"key":"custom_segment_id","value":"{{custome_segment_id}}"},{"description":{"content":"

[Optional] Choose a Theme to filter by

\n","type":"text/plain"},"key":"theme_id","value":"{{theme_id}}"},{"description":{"content":"

[Optional] Last Update Date From to filter by (YYYYMMDD_HHMMSS format)

\n","type":"text/plain"},"key":"updated_from","value":"{{updated_from}}"},{"description":{"content":"

[Optional] Last Update Date To to filter by (YYYYMMDD_HHMMSS format)

\n","type":"text/plain"},"key":"updated_to","value":"{{updated_to}}"}],"variable":[{"description":{"content":"

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"3dd30375-7956-b872-edbd-873eef126b2d"},{"name":"Create response","id":"70001058-ac53-eec1-7c44-c836fb0b2489","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"response\": {\n \"score\": 10,\n \"comment\": \"Sample comment\",\n \"user_meta\": {\n\t \"customer_id\": {\n\t \"type\": \"text\",\n\t \"value\": \"1234\",\n\t \"name\": \"Customer ID\"\n\t }\n\t },\n\t \"segments\": {\n\t \"customer_type\": {\n\t \"type\": \"text\",\n\t \"value\": \"New\",\n\t \"name\": \"Customer Type\"\n\t }\n\t },\n \"data_type\": \"NPS\",\n \"data_source\": \"Typeform\"\n }\n}"},"url":"https://api.chattermill.com/v1/:project/responses","description":"

Create response model with given attributes

[Required] Project key to create responses in (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"70001058-ac53-eec1-7c44-c836fb0b2489"},{"name":"Find responses matching criteria","id":"3e586e66-678f-0167-ec06-af9e1b715ef5","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"page\": \"1\",\n \"per_page\": \"20\",\n \"id\": \"123456\",\n \"user_meta[property]\": \"typeform_id\",\n \"user_meta[value]\": \"124343\",\n \"custom_segment_id\": \"123\"\n}"},"url":"https://api.chattermill.com/v1/:project/responses/search","description":"

Returns a paginated list of responses matching criteria given

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"d3c4c832-defe-4450-b14a-9f0667ac6ba6","name":"Find responses matching criteria","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"page\": \"1\",\n \"per_page\": \"20\",\n \"id\": \"123456\",\n \"user_meta[property]\": \"typeform_id\",\n \"user_meta[value]\": \"124343\",\n \"custom_segment_id\": \"123\"\n}"},"url":{"raw":"https://api.chattermill.com/v1/:project/responses/search","protocol":"https","host":["api","chattermill","com"],"path":["v1",":project","responses","search"],"variable":[{"key":"project","value":"{{project}}","type":"string","description":"[Required] Project `key` to fetch responses from (can be obtained from List Projects endpoint)"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"responses\": [\n {\n \"id\": 12345678901234567890,\n \"score\": 10,\n \"comment\": \"Example Comment\",\n \"original_comment\": \"Example Comment\",\n \"created_at\": \"2023-03-15T10:28:50.077Z\",\n \"updated_at\": \"2023-03-17T08:40:09.525Z\",\n \"user_attributes\": {\n \"name\": {\n \"name\": \"Name\",\n \"value\": \"James Bond\"\n },\n \"site\": {\n \"name\": \"Site\",\n \"value\": \"UK\"\n },\n \"order\": {\n \"name\": \"Order ID\",\n \"value\": \"007\"\n }\n },\n \"themes\": [\n {\n \"name\": \"Example Theme\",\n \"id\": 1,\n \"parent_id\": 2,\n \"sentiment\": -1,\n \"parent\": \"Example Category\"\n }\n ],\n \"phrases\": [\n {\n \"label\": \"example_phrase\",\n \"parent\": \"example_phrase_cluster\",\n \"sentiment\": -1.0\n }\n ]\n }\n]\n"}],"_postman_id":"3e586e66-678f-0167-ec06-af9e1b715ef5"}],"id":"6c93518a-d84f-179b-383e-7ebf9eb969c4","description":"

Operations related to Responses

\n","event":[{"listen":"prerequest","script":{"id":"507c9cdc-8a78-4f63-9bee-287695120850","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fda9ba70-2336-443e-ac80-75318d41359a","type":"text/javascript","exec":[""]}}],"_postman_id":"6c93518a-d84f-179b-383e-7ebf9eb969c4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Data Sources","item":[{"name":"Get a Data Source by ID","id":"6a447919-a77f-bb5a-34f5-266a705107ee","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/data_sources/:id","description":"

Returns a single Data Source

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"},{"description":{"content":"

[Required] id of Data Source to fetch

\n","type":"text/plain"},"type":"string","value":"{{id}}","key":"id"}]}},"response":[],"_postman_id":"6a447919-a77f-bb5a-34f5-266a705107ee"},{"name":"Get a list of Data Sources for a project","id":"f2ad9ac6-6c53-23f9-d3da-d1e7ed619bdc","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/data_sources","description":"

Returns all Data Sources

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"f2ad9ac6-6c53-23f9-d3da-d1e7ed619bdc"}],"id":"d37a5374-1280-1cd9-3888-0340472055c8","description":"

Operations related to Data Sources

\n","event":[{"listen":"prerequest","script":{"id":"cfc39095-1123-42f1-bae5-5264bb81955a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03e61bb5-65c1-4163-bde2-867a8b6cafab","type":"text/javascript","exec":[""]}}],"_postman_id":"d37a5374-1280-1cd9-3888-0340472055c8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Data Types","item":[{"name":"Get a Data Type by ID","id":"8a7d9a8c-f2b7-7a30-d75d-f1686c2905e9","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/data_types/:id","description":"

Returns a single Data Type

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"},{"description":{"content":"

[Required] id of Data Type to fetch

\n","type":"text/plain"},"type":"string","value":"{{id}}","key":"id"}]}},"response":[],"_postman_id":"8a7d9a8c-f2b7-7a30-d75d-f1686c2905e9"},{"name":"Get a list of Data Types for a project","id":"9022d585-0060-5185-9bbd-f3569a19e75a","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/data_types","description":"

Returns all Data Types

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"9022d585-0060-5185-9bbd-f3569a19e75a"}],"id":"2cd297e9-ce27-dee5-7eaf-c73ec0e5aa7b","description":"

Operations related to Data Types

\n","event":[{"listen":"prerequest","script":{"id":"3e5575d7-67e5-4525-acc5-f8ef4515e670","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"246b93b2-b165-4565-b406-bb22ae8a0461","type":"text/javascript","exec":[""]}}],"_postman_id":"2cd297e9-ce27-dee5-7eaf-c73ec0e5aa7b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Custom Segments","item":[{"name":"Get a list of Custom Segments for a project","id":"566130c0-0ea8-493f-b30d-b17b244a113b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://api.chattermill.com/v1/:project/custom_segments","description":"

Get a full list of Custom Segments you have access to on a given project.

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"566130c0-0ea8-493f-b30d-b17b244a113b"}],"id":"19464942-40ab-45f0-b1b5-29f4b41d5794","description":"

Operations related to Custom Segments

\n","event":[{"listen":"prerequest","script":{"id":"a02e59fa-dc77-4b0b-a4ad-a5858137a81b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9062ef13-78ab-47ab-ad82-f34d6986a0e4","type":"text/javascript","exec":[""]}}],"_postman_id":"19464942-40ab-45f0-b1b5-29f4b41d5794","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Metrics","item":[{"name":"Get value of a metric","id":"24a30a87-d175-44be-bfd7-aaf29fdf8634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.chattermill.com/v1/:project/metrics?type=nps&from={{from}}&to={{to}}&category={{category}}&theme={{theme}}&sentiment={{sentiment}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1",":project","metrics"],"host":["api","chattermill","com"],"query":[{"description":{"content":"

[Required] Type of metric to calculate (nps, average_score, net_sentimentz, volume)

\n","type":"text/plain"},"key":"type","value":"nps"},{"description":{"content":"

[Optional] Date From to filter by (UNIX timestamp format)

\n","type":"text/plain"},"key":"from","value":"{{from}}"},{"description":{"content":"

[Optional] Date To to filter by (UNIX timestamp format)

\n","type":"text/plain"},"key":"to","value":"{{to}}"},{"description":{"content":"

[Optional] Category name to filter by

\n","type":"text/plain"},"key":"category","value":"{{category}}"},{"description":{"content":"

[Optional] Theme name to filter by

\n","type":"text/plain"},"key":"theme","value":"{{theme}}"},{"description":{"content":"

[Optional] Sentiment name to filter by (-1, 0 or 1)

\n","type":"text/plain"},"key":"sentiment","value":"{{sentiment}}"}],"variable":[{"description":{"content":"

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"24a30a87-d175-44be-bfd7-aaf29fdf8634"}],"id":"fe01fb44-aa57-494d-8431-6e5f70a02fac","description":"

Operations related to metrics

\n","event":[{"listen":"prerequest","script":{"id":"0a54f428-91b8-46f1-a1e3-81008f41e45a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fbb66605-b10b-4fbf-abf7-327822539456","type":"text/javascript","exec":[""]}}],"_postman_id":"fe01fb44-aa57-494d-8431-6e5f70a02fac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Themes","item":[{"name":"Get a Theme by ID","id":"8a6e006b-c266-4f80-9774-37c41e1db9cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/themes/:id","description":"

Returns a single Data Type

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"},{"description":{"content":"

[Required] id of Data Type to fetch

\n","type":"text/plain"},"type":"string","value":"{{id}}","key":"id"}]}},"response":[],"_postman_id":"8a6e006b-c266-4f80-9774-37c41e1db9cc"},{"name":"Get a list of Themes for a project","id":"989dbf54-c58f-493b-8b9c-d444e4bef53b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/themes","description":"

Returns all Data Types

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"989dbf54-c58f-493b-8b9c-d444e4bef53b"}],"id":"3172a0cc-683e-465f-a802-6bef26a57918","_postman_id":"3172a0cc-683e-465f-a802-6bef26a57918","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}},{"name":"Categories","item":[{"name":"Get a Category by ID","id":"d4ce8146-f21a-438f-9db0-950bcd5be8f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/categories/:id","description":"

Returns a single Data Type

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"},{"description":{"content":"

[Required] id of Category to fetch

\n","type":"text/plain"},"type":"string","value":"{{id}}","key":"id"}]}},"response":[],"_postman_id":"d4ce8146-f21a-438f-9db0-950bcd5be8f9"},{"name":"Get a list of Categories for a project","id":"5f84cd40-217c-496a-b0f5-1bca2f958427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chattermill.com/v1/:project/categories","description":"

Returns all Data Types

[Required] Project key to fetch responses from (can be obtained from List Projects endpoint)

\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"5f84cd40-217c-496a-b0f5-1bca2f958427"}],"id":"94cf58bd-0df5-470e-a166-584f90886740","_postman_id":"94cf58bd-0df5-470e-a166-584f90886740","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","id":"dfa3fa5b-dd02-5b2e-1ea9-589165b969d0","name":"Chattermill API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"f0f40878-45c8-4ecd-8a61-9ae87d5eb6cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c380185b-eeee-477c-81d0-812695cd5856","type":"text/javascript","exec":[""]}}],"variable":[{"key":"Base URL","value":"https://api.chattermill.com"}]}

Authentication

Data Structure

Typical Workflows

Fetching new responses

Adding feedback to Chattermill

Actioning Data Erasure Requests (eg. per GDPR)

Enriching Chattermill Data

Getting Help

API Update Newsletter

Resources