Get a metric
Calculates a metric over the project’s responses. Without from and to, it covers the last 30 days.
Authentication
AuthorizationBearer
Your Chattermill API key, from Settings > API in the Chattermill app.
Path parameters
project
Your project’s key, from List projects.
Query parameters
type
Metric to calculate: nps, csat, average_score, net_sentiment or volume.
from
Start date, as YYYY-MM-DD.
to
End date, as YYYY-MM-DD.
custom_segment
Calculate the metric only for responses in this custom segment, by ID.
category
Name of the category that theme belongs to. Use it when two categories have a theme with the same name.
theme
Calculate the metric only for responses that mention the theme with this name. If no theme has this name, the filter is ignored.
sentiment
Use with theme to count only mentions with this sentiment, -1, 0 or 1.
Response
Metrics collection
metrics
Errors
401
Unauthorized Error

