Atlas API Overview

This guide provides general information about the Atlas APIs and how the Atlas objects interrelate.

On a high level, Atlas APIs let you do the following:

1. Manage Campaign

2. Pull Reports

3. View Organizations

4. Assign Ads

5. Manage Creatives

Next Steps

API Structure

An app is required to begin using the Atlas API. Since the Atlas API is built on the Graph API, you should review the Graph API document, an introduction to objects on the social graph, e.g. User, and the connections between the objects, e.g. friend relationships.

The Atlas API is made up of various objects and each object has connections to other objects as well. These connections are also known as relationships. For instance, a campaign is an object and a connection is the relationship between an advertiser and the cost package associated with the advertiser.

You can access a Graph object’s properties with its unique ID, for example, for the advertiser object:

  • https://graph.facebook.com/<API_VERSION>/{advertiser_id}

Similarly, placement and campaign objects have unique IDs and you can access specific placement and campaign objects with URLs like these:

  • https://graph.facebook.com/<API_VERSION>/{placement_id}
  • https://graph.facebook.com/<API_VERSION>/{campaign_id}

All Graph API objects work in a similar way. After you have authenticated, try some calls with the campaign object.

Atlas Objects Model Diagram

The diagram below represents the relationship between various objects in the Atlas eco-system.

Manage Campaign

Atlas application programming interface (API) enables you to create applications that can do the following:

  • Programmatically create and update click throughs, ads, adsets, cost packages, and placements.
  • Move placements to a specified cost package.
  • Retrieve hierarchical information about the entities that are associated with the campaign.
  • Create Ads, AdSets, ClickThroughs, and Placements/Packages - You can also create mixin and associate a campaign with it.

Pull Reports

Atlas application programming interface (API) enables users to create applications that can do the following:

  • Create report - You can choose the report type, provide report definition filters, report column definition and schedule a report.
  • Execute a report to generate a reportrun or schedule a reportrun.
  • Check the status of a report request i.e. reportrun.
  • Retrieve the download URL for a completed reportrun.

You can refer to the reporting guide document for more details.

View Organizations

Atlas application programming interface (API) enables you to create applications that can do the following:

  • Get information about the companies, branches, clients, and advertisers that are associated with your account.
  • Obtain information about the publishers and sites that are accessible from your account.
  • Create and Update audiences, segments, actiontags, multiactiontags for an advertiser.

You can refer to the individual organization api for more details. Please take a look at the following related APIs.

Assign Ads

The Atlas Ad Assignment service enables you to create applications that can:

  • Assign AdSets to Placements
  • Assign Ads to AdSets
  • Assign Ads to Placements

You can refer to the individual APIs for more details.

Manage Creatives

Atlas application programming interface (API) enables you to create applications that can do the following:

  • Programmatically create and update assets.
  • Retrieve information about the creatives, creativesets and assets associated with your account.

You can refer to the individual APIs for more details.