BeOp open API
BeOp has opened an API that allows external application to retrieve some information.
Usage#
Allowed method#
Currently, the only action that is allowed is the READ action through HTTP GET requests that return JSON responses. Initially, the API endpoints just give access to statistics.
The base url to access the API is https://data.beop.io/api
Security#
Access to BeOp API is protected by a personal API KEY that must be passed in every request as a query param ?api_key={YOUR_API_KEY}. The access to and management of API keys depend on whether you want to access stats for a Managed account or a Self one.
Managed account#
If you are a BeOp customer but not handling your own account / creatives / campaigns, you can contact our team and ask for an API key in order to integrate it in your workflows.
Self account#
If you are managing your own account / creatives / campaigns
In your BeOp Account, you will be able to find a section in the settings to manage your API keys
Learn how to manage your API keys in the next page
Entities#
To perform its mission, BeOp is managing some object/entities such as Accounts, Campaigns, Creatives, ...
A call to BeOp open API must include the name of the entities after the base url.
List items#
GET one item#
Progress#
Already developed enpoints cover :
General stats#
Based on these entities, BeOp is providing a route per entity to get statistics that are available in real-time. To use it, you just have to add /stats/ between /api/ and {entityName}