From tracking clicks and impressions to evaluating campaign performance across various dimensions, the API provides invaluable insights that drive informed decision-making and campaign optimization. Let’s explore how you can use the Readpeak data API to unlock actionable insights and maximize the impact of your advertising efforts.
Getting started with the Readpeak data API
To get started, visit the Readpeak website and navigate to the API section. Here, you can create your API key, which will grant you access to your campaign data. It’s important to keep your API key secure, as it serves as your gateway to accessing valuable campaign insights.
Once you have your API key, you can begin accessing and analyzing your campaign data. The Readpeak data API allows you to retrieve metrics such as clicks, impressions, and click-through rate (CTR), and group the data by dimensions such as campaign and article.
Visual editor for easy data access
The Readpeak data API also offers a visual editor that simplifies the process of accessing and querying your campaign data. Using the visual editor, you can easily build API requests by selecting the desired metrics and dimensions from dropdown menus and buttons. Additionally, you can customize the order of selected dimensions by dragging and dropping them in the list, allowing for greater flexibility and control over your data queries.
Advanced filtering options
One of the key features of the Readpeak Data API is its advanced filtering options, which allow you to refine your data queries based on various parameters such as time, clients, campaigns, and publishers. By using these filtering options, you can drill down into specific segments of your campaign data and gain deeper insights into performance trends and patterns.
Building custom reports
In addition to accessing data via the API, you can also build custom reports using the Readpeak platform. This feature enables you to create personalized reports tailored to your specific requirements, and export them in formats such as JSON, Excel, and CSV. Furthermore, you can save reports for future use, streamlining your reporting process and ensuring consistency in your analysis.
Endpoints
The end point for the API v1 is: https://api.readpeak.com/v1/reports/campaigns
Authorization There are two ways to authenticate the API usage.
1. Using Bearer authentication To use this method, send the API key in the Authorization header:
Authorization: Bearer <API KEY>
2. Using apikey parameter To use this method, add the API key to the apikey query parameter:
apikey=<API KEY>
For example https://api.readpeak.com/v1/reports/campaigns?apikey=70d66444-ecc4-4483-933e-084bdcd89e14
Available dimensions
ad group
Title for an ad group
ad group id
ID number for an ad group
advertiser
The brand name displayed on the ad variation (25 characters)
article creation date
The date an ad variation was created in the campaign
article title
The title of an ad variation (70 characters)
article update date
The date an ad variation was last updated
campaign
The name of the campaign
campaign creator
Email of the user that created the campaign
campaign creator name
Name of the user that created the campaign
client
The brand connected to the campaign
cta
Call to action text for the ad variation (20 characters)
currency
Choose currency for the campaign
date
Date for the data metrics selected
image url
Ad variation image URL
location
The publisher’s site name where ads have been displayed
target url
The click URL set in ad variation, where clicks from the ad will be directed
text
The teaser text set in the ad variation (120 characters)
theme
The theme label of an ad variation (20 characters)
variation no
The order number of an ad variation in an ad group
Use for predefined date ranges. See possible values in the “Select time” dropdown on Readpeak Reports API. Use the date parameter for custom date ranges.
date
Define custom date ranges using symbols <, <=, =, =>, >. Example: date=>2022-01-01&date<2022-02-01
filters
Add filters for client, campaign, or publisher. Example: filters=campaign%253DCampaignName%2Clocation%253DExampleSite
A full example https://api.readpeak.com/v1/reports/campaigns?apikey=2157b6ca-9a3f-4158-9ad4-1c838316c95c&metrics=clicks%2Cimpressions&dimensions=location%2Ccampaign&format=json&filters=campaign%253DCampaign1%2Clocation%253DSite1%2Cdate%3E%3D2022-06-01%2Cdate%3C%3D2022-06-15
Note that all URLs should be URL encoded.
Empowering informed decision-making
By integrating the Readpeak Data API into your workflow, you can make informed decision-making and drive campaign success easier. Whether you’re tracking campaign performance, checking the effectiveness of different creatives, or optimizing your targeting strategy, the Readpeak Data API provides the tools and resources you need.
