Skip to navigation

Introduction

Use the Chattermill API to send customer feedback into Chattermill and to read back what Chattermill found in it: themes, sentiment, observations and metrics.

The base URL depends on where your Chattermill account is hosted:

Your Chattermill appBase URL
app.chattermill.com (EU)https://api.chattermill.com/v1
app-us.chattermill.com (US)https://api-us.chattermill.com/v1

The examples in these docs use the EU base URL. If your account is in the US, replace api.chattermill.com with api-us.chattermill.com. Use an API key from the same app as your base URL.

How your data is organised

The main object is the response: one piece of customer feedback. It holds the comment, the score, any metadata you sent with it and, once Chattermill has processed it, the themes it mentions.

Responses belong to a project. You may have several projects, so most endpoints take a project key in the URL. To find yours, call List projects. The key is usually a lowercase version of your company’s name.

Within a project, responses are grouped by:

  • Data type: the kind of feedback, such as nps or review.
  • Data source: where it came from, such as Zendesk or Typeform.

Use them to work with one group of responses at a time. Projects, data types and data sources are read-only through the API.

Using Chattermill with AI agents

If you want an AI agent such as Claude, ChatGPT, Cursor or Copilot to answer questions about your feedback, we recommend the Chattermill MCP server over this API. Agents connect with your Chattermill login and see only the data your account can see. They can search feedback, summarise themes and observations, and pull metrics such as NPS and sentiment. There is no integration code to write or maintain.

The MCP server is read-only. To send feedback into Chattermill or update responses, use this API.

Full data export

If you need all of your data in your own warehouse, Chattermill also offers a full data export. It pushes your data to a shared AWS S3 or Google Cloud Storage bucket, and from there you can load it into Databricks, Redshift, BigQuery, Snowflake or another warehouse. Customers use it to join feedback with financial and business data, and to build reports in their BI tools. To set it up, contact your Customer Success Manager or support@chattermill.com.

Getting help

Email api@chattermill.com with any questions.

If you use the API, sign up for API updates and we’ll tell you about changes that affect you.