Statusbrew Insights API

The Statusbrew Insights API lets you pull analytics data from Statusbrew into your own dashboards, BI tools, or data warehouses. It's built for teams that want to use Statusbrew data as an input to external reporting systems, SLA tracking, or custom analytics workflows.

Availability

The Insights API is available on:

• Enterprise plan: It’s already part of the Enterprise plan. Contact your account manager to have it enabled for your account.

• Premium plan: Available as an add-on for $399/month

To get access, reach out to your dedicated account manager or email sales@statusbrew.com.

Authentication

All API requests require a Authorization header with a Bearer token. Your token is provisioned by your Statusbrew Account Manager when API access is activated for your account.

Include it in every request:

Authorization: Bearer YOUR_API_TOKEN

Keep your API token secure. Do not expose it in client-side code or public repositories. Contact your account manager if you need to rotate a token.

Base URL

All API requests use the following base URL:

https://api.statusbrew.com/v1

Getting Started

Follow these steps to understand how the Statusbrew Insights API works and make your first successful request.

• Step 1. Verify your token

• Step 2. Understand Helpers

• Step 3. Metric & Configs

• Step 4. Insights

See the full API documentation for the complete reference.

Verify Token

This confirms your Bearer token is valid and returns your account details, including your user ID, email, and timezone. Call this first to verify your setup before making any other requests.

End Point

GET /me

Helpers

Use these endpoints to fetch entity data that you will use as a payload in Insights queries.

See the full Helpers documentation for the complete reference.

Get Organizations

Returns all organizations you belong to, along with each organization's ID, name, and ownership status. Use the id value (orgn_xxxxx) to fetch members of a specific organization.

The id field in the response (e.g. orgn_xxxxx) is your Organization ID.

End Point

GET /organizations

Get Organization Users

Returns all users of a specific organization along with their roles, active status, and user details. Only Organization owners can call this endpoint. Use the member id values when building team-based filters or assigning data access.

End Point

GET /organizations/{organizationId}/members

Get Spaces

Returns a list of all Spaces across your organizations.

In the response, the id field (e.g. spce_xxxxx) is your Space ID. You will need this for all subsequent calls.

End Point

GET /spaces

Get Space Social Channels

Returns all social profiles connected to a Space, including their network type, URN, username, and authorization status. Use the URN values as dataSources filter values in POST /insights to narrow results to specific profiles.

End Point

GET /spaces/{spaceId}/channels

Get Space Tags

Returns all tags in a Space along with their names, scope, parent tags, and active status. Use tag IDs as filter values when querying Insights data by tag dimension.

End Point

GET /spaces/{spaceId}/tags

Metrics

Use these endpoints to discover what reporting metrics, dimensions, filters, and aggregators are available before building your Insights query.

See the full Metrics documentation for the complete reference.

Get Metrics, Categories, Dimensions

Returns all metrics available for a Space, grouped by category. Each metric includes its name, label, description, and supported networks. Use the name values from this response as inputs to GET /report_metric_config/{metricName} and POST /insights.

The API currently supports 250+ metrics across 22 categories.

For the full list of available metrics and their descriptions, see List of Report Metrics.

End Point

GET /spaces/{spaceId}/report_metrics

Get Supported Dimensions, Filters, Aggregator

Returns the exact dimensions, filters, comparison operators, and aggregator functions supported for a specific metric. Call this before building a POST /insights query to ensure you only pass valid combinations, using an unsupported dimension or filter for a metric will return an error.

End Point

GET /spaces/{spaceId}/report_metric_config/{metricName}

The following aggregators are supported across the API: Sum, Average, Min, Max, Percent. Availability varies by metric.

Insights API

Use these endpoints to query analytics data. All three variants accept the same request body. Choose the one that matches your use case. See the full Insights API documentation for the complete reference.

Get Reports

Returns all reports in a Space along with their sections, widgets, data sources, and saved filters. The top-level id field is your reportId. The id values inside sections[].grid[] are your widgetId values. You need both to use the Report-level and Widget-level Insights endpoints.

In the response, the top-level id field (e.g. rprt_xxxxx) is your Report ID. The id values inside sections[].grid[] (e.g. rpwd_xxxxx) are your Widget IDs.

End Point

GET /spaces/{spaceId}/reports

Insights with Space ID

Queries analytics using all profiles in the Space as data sources. This is the most flexible variant, ideal for cross-profile reporting or when you want to query without being tied to a specific saved report. You can use the filters field to narrow results to specific networks or profiles.

End Point

POST /spaces/{spaceId}/insights

Insights with Report ID

Queries analytics within the context of a specific Report, automatically applying that Report's saved data sources and filters. Use this when you want your API results to match what a user sees in a Statusbrew Report. Pass ignoreReportFilters: true to bypass the Report's saved filters and query raw data.

End Point

POST /reports/{reportId}/insights

Insights with Widget ID

Returns the exact data powering a specific widget inside a report. Use this to programmatically replicate or export a widget's data. Get the reportId and widgetId from GET /spaces/{spaceId}/reports.

End Point

POST /reports/{reportId}/widgets/{widgetId}/insights

Error Codes

The API uses standard HTTP status codes. All documented error codes and their corrective actions are in the full API reference.

• 200: Success

• 400: Bad request. Check your request body or parameters.

• 403: Forbidden. Your token lacks permission for this resource.

• 404: Not found. The requested resource does not exist.

• 405: Method not allowed.

• 415: Unsupported media type. Ensure Content-Type: application/json is set.

• 429: Rate limit exceeded. The API allows 50 requests per 5 minutes. Wait before retrying.

• 500: Internal server error.

• 503: Service unavailable.

• 524: A timeout occurred.

FAQs

How do I get access to the Insights API?

On Enterprise, the API is available on request. It is not enabled automatically. On Premium, it's available as an add-on for $399/month. In both cases, contact your account manager or email sales@statusbrew.com to get access.

Where do I find my API token?

API tokens are provisioned by your Statusbrew Account Manager. They are not self-generated in the product UI. Reach out to your account manager to get a token issued or rotated.

What should I do if my token is compromised?

Contact your account manager immediately to have the token revoked and a new one issued.

How do I find my Space ID?

Call GET /spaces. The response returns a list of all Spaces you belong to, each with a id field. Use that value spaceId in subsequent requests.

I'm on Enterprise but can't find the API section. What do I do?

Contact your dedicated account manager or email sales@statusbrew.com. They will confirm access is enabled for your account and issue your token.

Which Insights endpoint should I use?

Use POST /spaces/{spaceId}/insights for general queries across all profiles in your Space. Use POST /reports/{reportId}/insights to query within a specific Report's context. Use POST /reports/{reportId}/widgets/{widgetId}/insights to retrieve data for a specific widget.

How do I know which dimensions and filters are available for a metric?

Each metric has its own supported dimensions, filters, and aggregators. Call GET /spaces/{spaceId}/report_metric_config/{metricName} to see what's available for the specific metric you want to query.

Can I pull post-level data through the API?

Yes. You can break down the post_total metric using the post dimension to get post-level details, including the permalink. Call GET /spaces/{spaceId}/report_metric_config/post_total to see the full list of supported dimensions and filters for this metric.

Are there rate limits?

Yes. The API allows 50 requests per 5 minutes. If you exceed this, you will receive a 429 error. Wait before retrying your request.

What can I do with the Insights API?

Use the Insights API to pull reporting and analytics data from Statusbrew into your own tools and workflows. The API is read-only. You can retrieve data, but you cannot create, update, or delete anything through it.

How should POST endpoints be called?

POST endpoints should be called from your own application, backend, or an API client such as Postman.