Using Voluum Reporting API

Intro

 
Voluum exposes REST type API using secure HTTPS methods as a transport layer and JSON as a format. Our centric API gateway, api.voluum.com, is used to handle all requests to the relevant micro-services by the inclusion of distinct directory suffixes.




Full API documentation is available at 

http://developers.voluum.com                                                                                                                                          


Examples of directory suffix:

/report
/campaign
/traffic-source



Voluum Note: If you want to use Voluum API, you need to keep in mind that there is a limit of 15 API requests per second.


Certain requests also require a component identifier to be appended after a service directory, those of which are clearly indicated within our API documentation via curly brackets, for example:


/report/live/clicks/{campaignId}


where the {campaignId} token needs to be replaced with a valid ID string of a component from your Voluum account. Additional parameters relevant to a service are then placed in the URL’s query string (after the question mark, ?) to describe the requested data, for example:


?from=2017-05-20T00:00:00Z&to=2017-05-21T00:00:00Z&tz=Etc/GMT



Anatomy of a Request URL 


Provided below is a breakdown of the different parts included within this example request URL:

 






If you want to use the Voluum API using the access key without hard-coding your password in scripts, you need to generate it in the Voluum platform. 

To find out more, go to the Voluum API: Generating an Access Key article. 













   Contact us







Feedback and Knowledge Base