The Statusbrew Analytics API provides an externally accessible API for you to access your owned social profile analytics data so you can use that data to power BI dashboards, automate reporting, etc.
Before accessing the Analytics API, you must obtain an access token. To do so, contact your Statusbrew's Account Manager.
Note - Twitter has additional review and compliance requirements around exposing data through the Statusbrew Analytics API. You’re required to undergo a brief Twitter review and approval before being able to access their Twitter data through the Statusbrew Analytics API.
Contact your Statusbrew account manager to initiate the review process with Twitter. After Twitter approves your use case, the Account Owner needs to accept the Analytics API Twitter Content End User License Agreement.
https://api.statusbrew.com
| Customer Endpoints | Description |
|---|---|
GET /v1/me | Details of currently logged in User |
| Space Endpoints | Description |
|---|---|
GET /v1/spaces | Get a list of the available Spaces |
GET /v1/spaces/{space_id}/social_profiles | Get a list of Social Profiles |
GET /v1/spaces/{space_id}/social_profile_groups | Get a list of Social Profile Groups |
GET /v1/spaces/{space_id}/members | Get a list of Users |
GET /v1/spaces/{space_id}/user_groups | Get a list of User Groups |
GET /v1/spaces/{space_id}/tags | Get a list of Tags |
| Conversation Endpoints | Description |
|---|---|
GET /v1/spaces/{space_id}/conversation_metric_events | Get a list of conversation metric events |
GET /v1/spaces/{space_id}/conversation_activities | Get detail logs of activities on a conversation |
GET /v1/spaces/{space_id}/conversations/{conversationId} | Get detail of a conversation |
| Contact Endpoints | Description |
|---|---|
GET /v1/spaces/{space_id}/contacts/{contact_id} | Get detail of a particular contact |
| Analytics Endpoints | Description |
|---|---|
POST /v1/spaces/{space_id}/insights | Get values of reporting insights |
All of the external API endpoints use the following naming structure -
/{version}/spaces/{space_id}/{endpoint_path}
Where -
The API is versioned using a MAJOR.MINOR version format.
You can specify only the major number in requests, but the full version is included in responses.
A major version represents a breaking change to the API, including updates to the syntax and semantics for making requests of the APIs and the syntax and semantics of the response of the API.
A minor version represents a backwards compatible change to the API, such as adding new metrics, new endpoints, metric updates, etc. Minor versions are reflected in documentation, but not the API URL itself. Due to the backwards compatibility of minor versions, you only need to specify the major version in the URL path.
The number of requests will be limited depending on your Space's current subscription plan.
All requests have the following format -
| Type | Value |
|---|---|
| Authorization | Bearer |
| Accept | application/json |
| Content-Type | application/json |
The content body for all data API requests are JSON objects. Details of the structure of that JSON object depend on the type of endpoint used.
The following HTTP status codes returned with the response have the following meanings -
| Code | Meaning | Corrective Action |
|---|---|---|
| 200 OK | Request was processed successfully. | None. You should be able to access the result of the request in the response body. |
| 400 Bad Request | The request is malformed and does not conform with the request bodies specified in this document. | Update the request body. |
| 401 Unauthorized | The request does not contain a valid access token or that access token has expired. | Reauthenticate and obtain a fresh token. |
| 403 Forbidden | The request is accessing customer or profile data that the client is not allowed access to. | Update the request body. |
| 404 Not Found | The client is requesting an endpoint that does not exist. | Check your endpoint, and use an existing endpoint. |
| 405 Method Not Allowed | The client is using an HTTP verb that is not appropriate. | Use the HTTP verb listed for the API endpoint you’re using; typically POST or GET. See the specific endpoint documentation for details. |
| 415 Unsupoported Media Type | The client has submitted a request body that is not JSON or is requesting a response that is not JSON | Correct the Accept and Content-Type headers to use jSON. |
| 429 Too Many Requests | The client is making requests too quickly or has exhausted the allowed requests in a month. | Slow down your requests. |
| 500 Internal Server Error | The server had an issue processing the request. | Retry the request. If this code persists, contact support. |
| 503 Service Unavailable | The server is overloaded and cannot process the request. | Retry the request. If this code persists, contact support. |
| 504 Gateway Timeout | The server was unable to produce a result in time. | Retry the request. If this code persists, contact support or decrease the scope of the request (smaller date ranges, less profiles, etc.). |
The following headers are returned with each response -
| Header | Description | Sample Value |
|---|---|---|
| X-Brew-API-Version | Major and minor version of the response | 1.1 |
| X-Brew-Server-Version | Server version, including the major, minor, and build number. The major and minor version reflect the latest available version of the API. | 1.1.3018 |