Get message statistics

Request

Returns information about either current broadcast message or customer specific message view statistics.

GET https://partners.zoined.com/api/messaging

Security

partnerToken

Query

customerArray of strings

Optional customer IDs to apply the operation to specific partner companies only.

Example:customer=company_a

curl -i -X GET \
  'https://zone-api.zoined.com/_mock/api/messaging?customer=company_a' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

When request has been processed successfully.

Bodyapplication/json

titlestringrequired

Message title. Only very basic formatting html allowed.

Example:"Important message"

messagestringrequired

Message content. Only very basic formatting html allowed.

Example:"Message content here"

start_datestring, (date)

Date when to start showing the message

Example:"2020-01-01"

end_datestring, (date)

Date when to stop showing the message.

Example:"2020-01-31"

rolestring

Required role for users message is to be shown. Either user or admin.

Enum:"user""admin"

Example:"user"

total_viewsnumberrequired

Total number of views for all partner companies.

Example:120

customer_viewsobjectrequired

Total views per customer.

Response

{
  "title": "Important message",
  "message": "Message content here",
  "start_date": "2020-01-01",
  "end_date": "2020-01-31",
  "role": "user",
  "total_views": 120,
  "customer_views": {}
}