Access RollWorks Account Metrics

Note

Account metric data is only available to RollWorks customers on our Pro and Ultimate tiers. Standard tier customers do not receive account-based data and should use the GraphQL Reporting API to query campaign metrics.

You can access RollWorks account metrics using the GraphQL Reporting API. Metrics are available per account for a list of campaigns in an advertisable. You can specify any date range as long as it doesn’t exceed thirty days. If you need more than thirty days of data, you can make multiple queries and iterate on the date range.

Get to know the NextRoll API

Before you start building your integration, it helps to have a basic understanding of the NextRoll API.

Get Started with the NextRoll API will help you make your first API call.

Get to know NextRoll provides an overview of the object structure and defines common terminology.

Authentication

Use OAuth 2.0 to gain access to a user’s account. Our OAuth 2.0 implementation is compatible with standard libraries. You should be able to plug-in our token and authorization URLs into your favorite library.

See also:

• Get Started with OAuth 2.0

Retrieve account metrics

To retrieve account metrics, you’ll need to use the GraphQL Reporting API.

When querying the data, you’ll need to specify:

• Advertisable EID

• One or more campaign EIDs

• Start and end date

• Metrics that you want to retrieve. See FieldAccountMetrics for the complete list.

The response contains the metrics for the top 1,000 accounts by spend.

The response contains account metrics aggregated for all campaigns specified and the entire date range. If you want fine-grained reporting, you’ll need to query for a single campaign EID and day at a time.

Note

You can experiment with building queries using GraphiQL

The following is an example GraphQL query that shows account metrics for your campaigns:

{
  accountMetrics {
    summary(start: "yyyy-mm-dd", end: "yyyy-mm-dd", advertisableEID: "YOUR_ADVERTISABLE_EID", campaignEIDs: ["YOUR_CAMPAIGN_EID1", "YOUR_CAMPAIGN_EID2", "YOUR_CAMPAIGN_EID3"]) {
      domain
      cost
      impressions
      clicks
      adjustedClickThroughs
      adjustedViewThroughs
      pageViews
      uniqueVisitors
    }
  }
}

If you’re unfamiliar with how to make a GraphQL query using HTTP. See Your First Query for an example of how to package a query into an HTTP API call.