Skip to content
Documentation
FacebookYouTubeX (Twitter)

Analytics

You can use the API to get the analytics data.

Get the average waiting response time

Section titled “Get the average waiting response time”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/waiting

This is calculated over the last 30 days.

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the average waiting response time of the last day

Section titled “Get the average waiting response time of the last day”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/waiting/day/last

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the conversations count of the last 30 days

Section titled “Get the conversations count of the last 30 days”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/count

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the conversations count aggregated by the status field of the last 30 days

Section titled “Get the conversations count aggregated by the status field of the last 30 days”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/aggregate/status

With this endpoint you can get how many assigned, unassigned and archived conversations do you have.

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the conversations count aggregated by days

Section titled “Get the conversations count aggregated by days”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/aggregate/day

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the conversations count aggregated by months

Section titled “Get the conversations count aggregated by months”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/aggregate/month

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the conversations count aggregated by weeks

Section titled “Get the conversations count aggregated by weeks”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/aggregate/week

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the conversations count aggregated by hours

Section titled “Get the conversations count aggregated by hours”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/aggregate/hours

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the median conversations length

Section titled “Get the median conversations length”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/duration

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the median conversations length calculated over the last 30 days

Section titled “Get the median conversations length calculated over the last 30 days”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/duration

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the average customers rating of the conversations (Customer satisfaction)

Section titled “Get the average customers rating of the conversations (Customer satisfaction)”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/satisfaction

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the number of the conversations handled by a bot

Section titled “Get the number of the conversations handled by a bot”

GET https://api.pingstreams.com/v3/:project_id/analytics/requests/hasBot/count

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the total number of the messages sent and received during the last 30 days

Section titled “Get the total number of the messages sent and received during the last 30 days”

GET https://api.pingstreams.com/v3/:project_id/analytics/messages/count

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin

Get the total number of the messages sent and received aggregated by days during the last 30 days

Section titled “Get the total number of the messages sent and received aggregated by days during the last 30 days”

GET https://api.pingstreams.com/v3/:project_id/analytics/messages/aggregate/day

Path Parameters

Section titled “Path Parameters”
ParameterTypeDescription
project_idstringthe Project Id is a unique code assigned to your project when you create it in Pingstreams.

Headers

Section titled “Headers”
HeaderTypeDescription
AuthorizationstringAuthorization token. Basic Auth or JWT. Minumun role: admin