The ChatShipper Developer Hub

Welcome to the ChatShipper developer hub. You'll find comprehensive guides and documentation to help you start working with ChatShipper as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Basic metrics

Chatshipper API provides a simplified metrics interface that collects information about the organizations and presents in a single aggregated JSON structure.

The contents is curated manually and is compromised of the metrics we have identified as most useful.

Endpoint

https://api.chatshipper.com/v2/snapshot/metrics

Parameters

Parameter Description
start Required start date for the range, time is ignored
end Required start date for the range, time is ignored
organization optional organization filter
orgPath optional organization path filter

Examples

A simple GET request will gather all the information for the matching organizations and output a JSON structure:

Gather all the metrics for the organizations available to my user

 curl -H "Content-Type: application/json" -H "Authorization: ${TOKEN}"  "https://api.chatshipper.com/v2/snapshot/metrics?start=2020-02-01T00:00:00Z&end=2020-02-12T00:00:00Z"

Gather all the metrics for the given organization

 curl -H "Content-Type: application/json" -H "Authorization: ${TOKEN}"  "https://api.chatshipper.com/v2/snapshot/metrics?start=2020-02-01T00:00:00Z&end=2020-02-12T00:00:00Z&organization=${ORG_ID}"

Gather all the metrics of the subsidiaries of a given organization

 curl -H "Content-Type: application/json" -H "Authorization: ${TOKEN}"  "https://api.chatshipper.com/v2/snapshot/metrics?start=2020-02-01T00:00:00Z&end=2020-02-12T00:00:00Z&organization=!${ORG_ID}&orgPath=~${ORG_ID}"

JSON Response

The response is similar in all cases, the aggregates are calculated from all the organizations that match the query in the given range.

Note: If a measure is not avaiable for the requested query the field can be omitted or given a null response in the JSON structure.
JSON Path Description
active Mapping of collections that were active
active.conversations Conversations that had any king of messages posted
active.organizations Organizations that had any kind of activity, this refers only to the organization configuration
active.articles Articles that were created or modified
active.contacts Contacts that were created or modified
active.users Users that were created or modified
active.bots Users that were created or given the bot role
active.forms Forms created or modified
active.services Integrations created or modified
------ ----------------------
recurring.conversations Conversations that had any activity in the range but were created prior
------ ----------------------
total Total number of elements that existed during the range
total.conversations
total.organizations
total.articles
total.contacts
total.users
total.bots
total.forms
total.services
------ ----------------------
start Number of elements that existed at the beggining of the range (at 01:00:00 GMT)
start.conversations
start.organizations
start.articles
start.contacts
start.users
start.bots
start.forms
start.services
------ ----------------------
max Max number of elements that existed during the range (at 01:00:00 GMT)
max.conversations
max.organizations
max.articles
max.contacts
max.users
max.bots
max.forms
max.services
------ ----------------------
min Min number of elements that existed during the range (at 01:00:00 GMT)
min.conversations
min.organizations
min.articles
min.contacts
min.users
min.bots
min.forms
min.services
------ ----------------------
create Number of created elements during the range
create.results
create.messages
create.conversations
create.contacts
create.articles
create.attachments
create.events
create.services
------ ----------------------
update Number of updated elements during the range, using the API
update.contacts
update.services
update.locations
update.articles
update.events
update.users
update.organizations
------ ----------------------
delete Number of deleted elements during the range
delete.users
delete.services
------ ----------------------
view Number of directly accessed(direct API requests) elements during the range
view.contacts
view.forms
view.messages
view.articles
view.locations
view.events
------ ----------------------
results Breakdowns of results generated in the range
results.create.role Breakdown by role
results.create.role.admin
results.create.role.agent
results.create.role.bot
results.create.role.viewer
results.create.name Results breakdown by result name (label in the dashboard)
results.create.category Results breakdown by category
results.create.label Results breakdown by form label
------ ----------------------
messages Breakdown of messages created in the range
messages.create.type Breakdown of messages by type
messages.create.type.field
messages.create.type.form
messages.create.type.chat
messages.create.type.command
messages.create.type.postback
messages.create.type.card
messages.create.type.status
messages.create.type.mention
messages.create.type.results
messages.create.type.tag
messages.create.type.search
messages.create.type.report
messages.create.role Breakdown of messages by role
messages.create.role.contact
messages.create.role.bot
messages.create.role.agent
messages.create.role.system
messages.create.touchpoint Breakdown of messages by touchpoint used
messages.create.touchpoint.web
messages.create.touchpoint.sms
messages.create.touchpoint.whatsapp
messages.create.touchpoint.email
messages.create.touchpoint.facebook
------ ----------------------
conversations Breakdown of conversations in the range
conversations.create.type Breakdown of created conversations by type
conversations.create.type.contact
conversations.create.type.system
conversations.create.type.agent
conversations.create.type.bot
conversations.update.type Breakdown of update conversations by type
conversations.update.type.contact
conversations.update.type.system
conversations.update.type.agent
conversations.update.type.bot
------ ----------------------
services Breakdown for services
services.create.type Breakdown of services created by type
services.create.type.messenger
services.create.type.whatsapp

Updated about a month ago

Basic metrics


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.