Chartboost API Overview

With the Chartboost API, you can access campaign and app analytics, retrieve account and earnings information, upload, update campaign bids, and more.
  • Authentication: You need to include your account’s user ID and user signature to authenticate your API requests. You can find your user ID and user signature at the top of your dashboard’s API Explorer page.
  • HTTP methods: Required HTTP methods — GET, POST, PUT, etc. — vary by endpoint. View each request’s HTTP method in your dashboard’s API Explorer. All requests should be made via HTTPS. The example for analytics listed below shows two queries — an initial request to queue the job, and the follow-up query that uses the job ID to retrieve the results.
// pseudo-code example for initial query request
query_url = "https://analytics.chartboost.com/v3/metrics/campaign?" + query_params
query_params = "... groupBy=app,creative ..."

response = get(query_url);
if (response.status = 202) {
  jobId = response.parse('jobId');
  // capture the jobId for retrieve() function
  file.write(jobId);
  }
else {
  // handle failure
};


// pseudo-code example of retrieving the result by jobId
query_url = "https://analytics.chartboost.com/v3/metrics/jobs/" + jobId
query_params = ""

created = get(query_url + "?status=true");
if (created.status == 201) {
response = get(query_url);
if (response.status == 200) {
// get nerdy with data
}
else {
// handle failure
}
};
  • After receiving GET /campaign and GET /install queries that use the groupBy parameter, the Chartboost API will respond with a job ID that serves as confirmation that the request has been accepted and queued for processing.
  • You can then use the ID to check the job’s status in a subsequent request, using this new endpoint: GET /v3/metrics/jobs/[job_id]?status=true
  • The query will return 201 {status: "created"} if the job results are ready to be collected. Once your system receives that response, you can pull the data like so: GET /v3/metrics/jobs/[job_id]
  • If you try to retrieve your data before the job is finished, you may receive an empty or incomplete response.
  • Query results are stored and available for up to 24 hours before deletion.
  • Currently, the only supported content-type is application/octet-stream, where results are returned in TSV form (note that our TSV files still have .csv extensions).
  • API methods: The Chartboost API features four different types of methods — analytics methods, app methods, campaign methods, account methods. Each method type has unique endpoints. Use your dashboard’s API Explorer or one of the options below to find the right endpoint for your request.
  • Parameters: Add parameters to build your requests for testing. Required parameters appear in red in your dashboard.
  • Most analytics reports returned from our API are in JSON format. Specific queries are returned in TSV (tab-separated value) format. Learn more about formatting ▶
  • Please follow the Chartboost API rules listed below.

▲ Back to top


These guidelines help us ensure that all customers’ requests are returned quickly. If you do not respect these limits, your API access will be limited.

Play nice with our API for your sake and the sake of other Chartboost customers.
Space out your requests. If you need to receive five different reports each day, don’t send all five requests at the same time. Give your requests at least a few minutes of breathing room. Your API access will be limited if you make more than 1 query per minute.
Group your apps into a single request. Instead of sending a unique API request for each app, drop the appId parameter and let the API return data for all the apps.

▲ Back to top


Analytics Methods App Methods Campaign Methods Account Methods

 


You might also like…