Measure API Introduction

With the Measure API, you can allow your third-party software tools to receive the channel-level and content-level metrics data offered by Measure.

Note:

This article offers an introduction to the Social Media Management Measure API. For developer information, please visit Social Media Management's API Technical Documentation. Visit our article on Getting Access to Social Media Management APIs for first-time steps.


Benefits of the Measure API

The Measure API allows you to build integrations between Measure and the third-party analytics tools (e.g. Google Data Studio, Power BI, etc.) that you use to assess your social media performance. By integrating with the Measure API, you can get even more insights from your social media networks and build more unified reporting across your analytics platforms. The Measure API offers all of the same metrics from Measure’s dashboards. Below are a few examples on how you can use the Measure API.

  • Perform more complex analysis of social data by easily incorporating social metrics from Measure into your big data from other sources (e.g. email, sales, SEO).
  • Build custom KPIs by retrieving the metrics from Measure and aggregating them to create custom KPIs to measure social goals.
  • Build integrations with data visualization tools by integrating the metrics into BI & analytics tools, so you can create dashboards within these tools.
  • Apply your branding and presentation guidelines into the social data coming from Measure dashboards.

Measure API endpoints

There are five endpoints available in the Measure API:

Get Channel Metrics Metadata

The Get Channel Metrics Metadata endpoint will retrieve all of the supported Measure channel metrics for each channel you have connected to Social Media Management. You can choose to filter by the social media networks that are supported by Measure (e.g. Facebook, Instagram, X (Twitter), LinkedIn, and TikTok). If no filters are applied, the endpoint will retrieve channel metrics for all connected channels and supported networks by default.

Upon retrieval, the endpoint will provide the Channel Metric ID, associated social network, the title of the metric, a description of the metric, the formula used to calculate the metric, and breakdowns of the metric unique identifier and title.

Your Social Media Management API key is required to run the Get Channel Metrics Metadata endpoint. Visit our article Getting Access to Social Media Management APIs to learn how to generate your API key.

Request Channel Insights

The Request Channel Insights endpoint allows you to request insights to analyze your overall channel performance. It will give you a daily snapshot of a channel’s activity, such as how many new fans you gained or lost on a channel, how your channel reach varies between organic and paid posts, where your channel fans came from, when your fans are online, and much more.

You can choose which channels, metrics, and time period you would like to receive data for. The Measure API offers insights from up to two years and three months ago.

Note:

The Request Channel Insights endpoint has rate limits of 15 channels per request, 20 Metric IDs per request, and 3 months between requests.

To run the Request Channel Insights endpoint, you will need to specify the Channel UUIDs and Metric IDs for the channels and channel metrics you would like to retrieve respectively.

After you run the Request Channel Insights endpoint, you will use the Insights Request ID it generates to retrieve your Channel insights using the Get Insights endpoint outlined below.

Get Content Metrics Metadata

The Get Content Metrics Metadata endpoint will retrieve all of the supported Measure content metrics for each channel you have connected to Social Media Management. You can choose to filter by the social media networks that are supported by Measure (e.g. Facebook, Instagram, X (Twitter), LinkedIn, and TikTok). If no filters are applied, the endpoint will retrieve content metrics for all connected channels and supported networks by default.

Upon retrieval, the endpoint will provide the content Metric IDs, associated social network, the title of the metric, a description of the metric, and the formula used to calculate the metric.

Your Social Media Management API key is required to run the Get Content Metrics Metadata endpoint. Visit our article Getting Access to Social Media Management APIs to learn how to generate your API key.

Request Content Insights

The Request Content Insights endpoint will provide content metrics for specific posts that you identify. In content insights, you will find impressions, reach, likes, shares, and other metrics that show how well specific posts have performed. You can choose which posts, metrics, and time period you would like to receive data for.

Note:

The Request Content Insights endpoint has rate limits of 15 channels per request, 20 Metric IDs per request, 300 Content IDs per request, and a maximum time period of three months between your chosen "since" period and "until" period. Historical data up to two years and three months ago is available.

To run the Request Content Insights endpoint, you will need to specify the Channel UUIDs, Content IDs, and Metric IDs for the channels, posts, and content metrics you would like to retrieve respectively.

  • Channel UUIDs and Content IDs can be obtained using the Get Channel Content endpoint from the Content API. See How Can I Find Channel UUIDs and How Can I Find Content IDs below.

    Note:

    Channel IDs, rather than Channel UUIDs, are needed in order to run the Get Channel Content endpoint from the Content API. First, obtain your Channel IDs from the Get Channels endpoint from the Channel API (see How Can I Find Channel IDs below). Then, use the Channel IDs to run the Get Channel Content endpoint from the Content API to retrieve your Channel UUIDs and Content IDs needed for Request Content Insights.

  • Content Metric IDs can be obtained from the Get Content Metrics Metadata endpoint above.

After you run the Request Content Insights endpoint, you will use the Insights Request ID it generates to retrieve your content insights using the Get Insights endpoint outlined below.

Get Insights

The Get Insights endpoint will retrieve the data you requested via Request Channel Insights or Request Content Insights, providing you Channel-level or content-level insights from Measure based on the parameters you have specified.

To run the Get Insights endpoint, you will need the Insights Request ID generated by either the Request Channel Insights or Request Content Insights endpoint, as well as your Social Media Management API key. Visit our article Getting Access to Social Media Management APIs to learn how to generate your API key.


Finding a Channel UUID

Channel UUIDs, which identify specific channel(s) that you have connected to Social Media Management, can be obtained via the Get Channels endpoint from the Channel API. The Get Channels endpoint will return a list of all channels in your organization, along with data such as the channel name, connected status, network, UUID, and ID.

Tip:

Channel UUIDs can also be obtained via the Get Channel Content endpoint from the Content API.


Finding a Channel ID

Channel IDs, rather than Channel UUIDs, are required to run the Get Channel Content endpoint from the Content API. Channel IDs can be obtained from the Get Channels endpoint from the Channel API.


Finding a Content ID

Content IDs, which identify all of your published, unpublished, and scheduled posts in Social Media Management, can be obtained from the Get Channel Content endpoint via the Content API. The Get Channel Content endpoint will return a list of all of the published, unpublished, and scheduled posts created by your organization, along with data such as the network, post status, post type, and the content ID.


Finding a Metric ID

Metric IDs, which identify the specific channel-level or content-level metrics you would like to retrieve from Measure, can be obtained from the Get Channel Metrics Metadata endpoint or the Get Content Metrics Metadata endpoint in the Measure API.


Finding an Insights Request ID

Insights Request IDs, which identify a specific insights request, are generated when you run the Get Channel Insights or Request Content Insights endpoints.


Accessing technical documentation

For general information about the features of our available APIs, check out our Introduction to APIs section. To view technical documentation for each Social Media Management API, please visit: falconio.docs.apiary.io.

Was this article helpful?
0 out of 1 found this helpful
Brandwatch Academy

The Brandwatch Academy is here

Access on-demand courses on the Brandwatch product suite, plus live events to enrich your knowledge.