Marketing API Version

ReportRuns

Provides operations to create, read, update and delete Reportruns.

Read ReportRuns

Permissions

A user access token with Atlas API capability is required to read reportruns.

Fields

Reading a reportrun will return a ReportRun object.

Read ReportRuns

You can get report runs for a report by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<REPORT_ID>/report_runs

Response:

{
  "data": [
    {
      "company_id": "11002200631700", 
      "created_date": "2014-08-27T21:54:45+0000", 
      "definition": {
        "column_definitions": [
          {
            "aggregation_usage": "dimension", 
            "area": "serving", 
            "category": "standard", 
            "description": "The id of the advertiser.", 
            "incompatibilities": [
              {
                "category": "standard", 
                "key": "action_requests"
              }
            ], 
            "key": "advertiser_id", 
            "name": "Advertiser ID"
          }, 
          {
            "aggregation_usage": "dimension", 
            "area": "serving", 
            "category": "standard", 
            "description": "The name of the advertiser.", 
            "incompatibilities": [
              {
                "category": "standard", 
                "key": "action_requests"
              }
            ], 
            "key": "advertiser_name", 
            "name": "Advertiser Name"
          }, 
          {
            "aggregation_usage": "dimension", 
            "area": "serving", 
            "category": "standard", 
            "description": "The id of the campaign.", 
            "incompatibilities": [
              {
                "category": "standard", 
                "key": "action_requests"
              }
            ], 
            "key": "campaign_id", 
            "name": "Campaign ID"
          }, 
          {
            "aggregation_usage": "dimension", 
            "area": "serving", 
            "category": "standard", 
            "description": "The name of the campaign.", 
            "incompatibilities": [
              {
                "category": "standard", 
                "key": "action_requests"
              }
            ], 
            "key": "campaign_name", 
            "name": "Campaign Name"
          }, 
          {
            "aggregation_usage": "metric", 
            "area": "attribution", 
            "attribution_model": "full_path", 
            "category": "standard", 
            "description": "Value of extended data metric 1 based on full path attribution.", 
            "incompatibilities": [
              {
                "category": "standard", 
                "key": "action_requests"
              }, 
              {
                "category": "standard", 
                "key": "dpb_event_ts"
              }, 
              {
                "category": "standard", 
                "key": "dpb_category"
              }, 
              {
                "category": "standard", 
                "key": "dpb_hashed_cookie"
              }, 
              {
                "category": "standard", 
                "key": "dpb_ip_address"
              }, 
              {
                "category": "standard", 
                "key": "dpb_is_tentative"
              }, 
              {
                "category": "standard", 
                "key": "dpb_contributor_time"
              }, 
              {
                "category": "standard", 
                "key": "dpb_conversion_type"
              }, 
              {
                "category": "standard", 
                "key": "dpb_xdata"
              }, 
              {
                "category": "standard", 
                "key": "dpb_audience_id"
              }, 
              {
                "category": "standard", 
                "key": "dpb_audience_name"
              }, 
              {
                "category": "standard", 
                "key": "dpb_event_id"
              }, 
              {
                "category": "standard", 
                "key": "dpb_clickthrough_url"
              }, 
              {
                "category": "standard", 
                "key": "dpb_country"
              }, 
              {
                "category": "standard", 
                "key": "dpb_state"
              }
            ], 
            "key": "action_metric_1_full_path", 
            "name": "Action Metric 1 - Even Credit"
          }, 
          {
            "aggregation_usage": "metric", 
            "area": "attribution", 
            "attribution_model": "last_touch", 
            "category": "standard", 
            "description": "Value of extended data metric 1 based on last touch attribution.", 
            "incompatibilities": [
              {
                "category": "standard", 
                "key": "action_requests"
              }, 
              {
                "category": "standard", 
                "key": "dpb_event_ts"
              }, 
              {
                "category": "standard", 
                "key": "dpb_category"
              }, 
              {
                "category": "standard", 
                "key": "dpb_hashed_cookie"
              }, 
              {
                "category": "standard", 
                "key": "dpb_ip_address"
              }, 
              {
                "category": "standard", 
                "key": "dpb_is_tentative"
              }, 
              {
                "category": "standard", 
                "key": "dpb_contributor_time"
              }, 
              {
                "category": "standard", 
                "key": "dpb_conversion_type"
              }, 
              {
                "category": "standard", 
                "key": "dpb_xdata"
              }, 
              {
                "category": "standard", 
                "key": "dpb_audience_id"
              }, 
              {
                "category": "standard", 
                "key": "dpb_audience_name"
              }, 
              {
                "category": "standard", 
                "key": "dpb_event_id"
              }, 
              {
                "category": "standard", 
                "key": "dpb_clickthrough_url"
              }, 
              {
                "category": "standard", 
                "key": "dpb_country"
              }, 
              {
                "category": "standard", 
                "key": "dpb_state"
              }
            ], 
            "key": "action_metric_1_last_touch", 
            "name": "Action Metric 1 - Last"
          }
        ], 
        "columns": [
          "advertiser_id", 
          "advertiser_name", 
          "campaign_id", 
          "campaign_name", 
          "action_metric_1_full_path", 
          "action_metric_1_last_touch"
        ], 
        "date_range": {
          "begin_date": "2014-08-27T00:00:00-0400", 
          "date_unit": "", 
          "end_date": "2014-08-28T00:00:00-0400", 
          "quantity": "0", 
          "start_date": "2014-08-27T00:00:00-0400", 
          "time_zone": "America/New_York", 
          "type": "absolute"
        }, 
        "filters": {
          "client_ids": [
            "11002200631300"
          ], 
          "include_tentative_cookies": false
        }, 
        "include_empty_metric_rows": false, 
        "report_type": "column_determined", 
        "time_zone": "America/New_York"
      }, 
      "description": "", 
      "email_suffix": "", 
      "error_code": "1", 
      "file_format": "csv", 
      "id": "11002200631800", 
      "last_modified_date": "2014-08-27T21:54:55+0000", 
      "name": "Test Report", 
      "report_id": "11002200631500", 
      "status": "error", 
      "version": "3"
    }
  ]
} 

Curl Example

A curl example to read reportruns of a report:

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<REPORT_ID>/report_runs

Create Atlas ReportRuns

Permissions

A user access token with Atlas API capability is required to create reportruns.

Fields

Creating a reportrun will return a ReportRun object.

Create User ReportRuns

You can create report runs for your reports by making an HTTP POST request to publisher end point.

An example of the request and response:

Request:

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

Response:

{
  "data": [
    {
      "report_run": {
        "id": "11002200631800", 
        "created_by": "1444052100", 
        "created_date": "2014-09-05T10:12:05-07:00", 
        "last_modified_by": "1444052100", 
        "last_modified_date": "2014-09-05T10:12:05-07:00", 
        "is_deleted": false, 
        "version": "1", 
        "report_id": "11002200631500", 
        "everstore_handle": "", 
        "definition": {
          "columns": [
            "advertiser_id", 
            "advertiser_name", 
            "campaign_id", 
            "campaign_name", 
            "action_metric_1_full_path", 
            "action_metric_1_last_touch"
          ], 
          "filters_map": {
            "campaign_ids": [
            ], 
            "site_ids": [
            ], 
            "placement_ids": [
            ], 
            "ad_set_ids": [
            ], 
            "client_ids": [
              "11002200631300"
            ], 
            "advertiser_ids": [
            ], 
            "ad_ids": [
            ], 
            "publisher_ids": [
            ]
          }, 
          "date_range": {
            "start_date": "2014-09-05T00:00:00-04:00", 
            "end_date": "2014-09-06T00:00:00-04:00", 
            "date_unit": "", 
            "quantity": "0", 
            "type": "absolute", 
            "begin_date": "2014-09-05T00:00:00-04:00", 
            "time_zone": "America/New_York"
          }, 
          "time_zone": "America/New_York", 
          "report_type": "column_determined", 
          "filters": {
            "client_ids": [
              "11002200631300"
            ], 
            "include_tentative_cookies": false
          }, 
          "include_empty_metric_rows": false, 
          "column_definitions": [
            {
              "category": "standard", 
              "key": "advertiser_id", 
              "name": "", 
              "aggregation_usage": "metric", 
              "attribution_model": "full_path"
            }, 
            {
              "category": "standard", 
              "key": "advertiser_name", 
              "name": "", 
              "aggregation_usage": "metric", 
              "attribution_model": "full_path"
            }, 
            {
              "category": "standard", 
              "key": "campaign_id", 
              "name": "", 
              "aggregation_usage": "metric", 
              "attribution_model": "full_path"
            }, 
            {
              "category": "standard", 
              "key": "campaign_name", 
              "name": "", 
              "aggregation_usage": "metric", 
              "attribution_model": "full_path"
            }, 
            {
              "category": "standard", 
              "key": "action_metric_1_full_path", 
              "name": "", 
              "aggregation_usage": "metric", 
              "attribution_model": "full_path"
            }, 
            {
              "category": "standard", 
              "key": "action_metric_1_last_touch", 
              "name": "", 
              "aggregation_usage": "metric", 
              "attribution_model": "full_path"
            }
          ]
        }, 
        "name": "Test Report", 
        "description": "", 
        "company_id": "11002200631700", 
        "status": "scheduled", 
        "email_suffix": "", 
        "error_code": "0", 
        "owner_name": "Firstname Lastname"
      }
    }
  ]
}

Curl Example

A curl example to create reportruns of your reports:

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

Delete Atlas Reportruns

You cannot delete atlas reportruns.

Connections or Related Endpoints of AtlasReportRun (Edges)

NameDescription

/reportrundata

Represents reportrun data for atlas reports