Marketing API Version

Reach Overlap Reports

Permissions

A user access token with Atlas API capability is required to request reach overlap report details.

Create ReachOverlapReports

You can create company reach overlap reports by making an HTTP POST request. It will update the report if it already exists.

To get more information, see the details of the Report API.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<COMPANY_ID>/reports?
reports=[{
  "name":"Test2_ReachOverlap",
  "version":"1","description":"",
  "definition":{
    "report_type":"reach_overlap",
    "column_definitions":[
      {"area":"serving","attribution_model":null,"category":"standard","key":"advertiser_name","name":"Advertiser Name","aggregation_usage":"dimension"},{"area":"serving","attribution_model":"last_touch","category":"standard","key":"fb_identity_unique_reach","name":"Unique Reach (People)","aggregation_usage":"metric"},{"area":"serving","attribution_model":"last_touch","category":"standard","key":"counters_impressions","name":"Impressions","aggregation_usage":"metric"}
    ],
  "date_range":{"type":"relative","date_unit":"day","quantity":"0","time_zone":"America/New_York"},
  "time_zone":"America/New_York","filters":{"client_ids":["11002200631300"]}},
  "file_format":"xlsx",
  "is_email_enabled":false,
  "email_addresses":[],
  "email_suffix":""
}]

Execute Datapassback Reports

You can execute DPB reports for a company to create a reportrun by making an HTTP POST request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<COMPANY_ID>/report_runs?report_ids=[<REPORT_ID>]

Response:

{
  "data": [
    {
      "id": "11002200634100", 
      "success": true
    }
  ]
}

Curl Example

A curl example to execute DPB reports for a company:


curl \ -F 'report_ids=[<REPORT_ID>]' \ -F 'access_token=<ACCESS_TOKEN>' \ https://graph.facebook.com/<API_VERSION>/<COMPANY_ID>/report_runs

Download Datapassback Reports

Downloading Datapassback report will return a data file in csv format.

You can get DPB reports by making an HTTP GET request.

An example of the request and response:

Request:

https://lookaside.fbsbx.com/adsatlas/download/passback/?access_token=<ACCESS_TOKEN>&id=<REPORT_RUN_ID>&filename=TestReportDownload

Response:

The response will be a file download generated named TestReportDownload.csv

Curl Example

A curl example to create reportruns of your reports:

curl -G \ 
  -d 'id=<REPORT_RUN_ID>' \
  -d 'filename=TestReportDownload' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://lookaside.fbsbx.com/adsatlas/download/passback