Graph API Version

Atlas Campaign

Reading

An Atlas Campaign

Example

Graph API Explorer
GET /v5.0/{atlas-campaign-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{atlas-campaign-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{atlas-campaign-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{atlas-campaign-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{atlas-campaign-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
metric_scope
JSON object

Filters that scope the time period for which metrics are returned. Defined as a shape with the properties "filters", "should_include_prior_period", and "time_period".

date_range

filters
dictionary { enum {CLICK_LOOKBACK_WINDOW, LOOKBACK_WINDOW, VERSION_ID, VIEW_LOOKBACK_WINDOW, VISIT_CONFIGURATION} : <string> }
Default value: {}

should_include_prior_period
boolean
Default value: false

time_period
enum {ALL_AVAILABLE, ALL_DATES, CUSTOM, DATE_RANGE, FIFTEEN_DAYS, LAST_FOURTEEN_DAYS, LAST_HUNDRED_FOURTY_FOUR_HOURS, LAST_MONTH, LAST_NINETY_DAYS, LAST_QUARTER, LAST_SEVEN_DAYS, LAST_SIXTY_DAYS, LAST_THIRTY_DAYS, LAST_TWENTY_FOUR_HOURS, LAST_YEAR, MONTH_TO_DATE, QUARTER_TO_DATE, SEVEN_DAYS, THIRTY_DAYS, THIS_MONTH_WHOLE_DAYS, TODAY, WEEK_TO_DATE, YEAR_TO_DATE, YESTERDAY}
Default value: all_dates

metric_context
JSON object

business_unit_id
string

business_unit_id

active_pane
string

active_pane

Fields

FieldDescription
id
numeric string

ID of the campaign

ad_platform

The connection this campaign is tracked with

alias
string

Alias given to the campaign, which typically corresponds to an external ID used for search campaigns

cost_per_1k_impressions
float

Cost per 1k impressions

cost_per_click
float

Cost per click

cost_per_visit
float

Cost per visit

created_by
AtlasUserProfile

The profile that created the campaign

created_date
datetime

Date on which the campaign was created

data_driven_convs
float

Data-driven model conversions

data_driven_convs_per_1k_impress
float

Data-driven model conversions per 1k impressions

data_driven_convs_per_click
float

Data-driven model conversions per click

data_driven_convs_per_visit
float

Data-driven model conversions per visit

data_driven_cpa
float

Data-driven model CPA

data_driven_nullable_convs
float

Data-driven model nullable conversions

data_driven_revenue
float

Data-driven model revenue

data_driven_roas
float

Data-driven model ROAS

even_credit_convs
float

Even credit model conversions

even_credit_convs_per_1k_impress
float

Even credit model conversions per 1k impressions

even_credit_convs_per_click
float

Even credit model conversions per click

even_credit_convs_per_visit
float

Even credit model conversions per visit

even_credit_cpa
float

Even credit model CPA

even_credit_revenue
float

Even credit model revenue

even_credit_roas
float

Even credit model ROAS

first_click_convs
float

First click model conversions

first_click_convs_per_1k_impress
float

First click model conversions per 1k impressions

first_click_convs_per_click
float

First click model conversions per click

first_click_convs_per_visit
float

First click model conversions per visit

first_click_cpa
float

First click model CPA

first_click_revenue
float

First click model revenue

first_click_roas
float

First click model ROAS

first_touch_convs
float

First touch model conversions

first_touch_convs_per_1k_impress
float

First touch model conversions per 1k impressions

first_touch_convs_per_click
float

First touch model conversions per click

first_touch_convs_per_visit
float

First touch model conversions per visit

first_touch_cpa
float

First touch model CPA

first_touch_revenue
float

First touch model revenue

first_touch_roas
float

First touch model ROAS

is_archived
bool

Indicates whether the campaign is hidden

last_click_convs
float

Last click model conversions

last_click_convs_per_1k_impress
float

Last click model conversions per 1k impressions

last_click_convs_per_click
float

Last click model conversions per click

last_click_convs_per_visit
float

Last click model conversions per visit

last_click_cpa
float

Last click model CPA

last_click_revenue
float

Last click model revenue

last_click_roas
float

Last click model ROAS

last_click_with_extrapolation_convs
float

Last click with extrapolation model conversions

last_click_with_extrapolation_convs_per_100_clicks
float

Last click with extrapolation model conversions per 100 clicks

last_click_with_extrapolation_convs_per_1k_impress
float

Last click with extrapolation model conversions per 1k impressions

last_click_with_extrapolation_convs_per_click
float

Last click with extrapolation model conversions per click

last_click_with_extrapolation_convs_per_visit
float

Last click with extrapolation model conversions per visit

last_click_with_extrapolation_cpa
float

Last click with extrapolation model CPA

last_click_with_extrapolation_revenue
float

Last click with extrapolation model revenue

last_click_with_extrapolation_roas
float

Last click with extrapolation model ROAS

last_click_with_extrapolation_unattributed
float

Last click with extrapolation model unattributed conversions

last_modified_by
AtlasUserProfile

The profile that last edited the campaign

last_modified_date
datetime

Date on which the campaign was last edited

last_touch_convs
float

Last touch model conversions

last_touch_convs_per_1k_impress
float

Last touch model conversions per 1k impressions

last_touch_convs_per_click
float

Last touch model conversions per click

last_touch_convs_per_visit
float

Last touch model conversions per visit

last_touch_cpa
float

Last touch model CPA

last_touch_revenue
float

Last touch model revenue

last_touch_roas
float

Last touch model ROAS

name
string

Name of the campaign

net_media_cost
float

Net media cost

positional_30fl_convs
float

Positional model 30fl conversions

positional_30fl_convs_per_1k_impress
float

Positional model 30fl conversions per 1k impressions

positional_30fl_convs_per_click
float

Positional model 30fl conversions per click

positional_30fl_convs_per_visit
float

Positional model 30fl conversions per visit

positional_30fl_cpa
float

Positional model 30fl CPA

positional_30fl_revenue
float

Positional model 30fl revenue

positional_30fl_roas
float

Positional model 30fl ROAS

positional_40fl_convs
float

Positional model 40fl conversions

positional_40fl_convs_per_1k_impress
float

Positional model 40fl conversions per 1k impressions

positional_40fl_convs_per_click
float

Positional model 40fl conversions per click

positional_40fl_convs_per_visit
float

Positional model 40fl conversions per visit

positional_40fl_cpa
float

Positional model 40fl CPS

positional_40fl_revenue
float

Positional model 40fl revenue

positional_40fl_roas
float

Positional model 40fl ROAS

report_click_through_rate
float

Report click through rate

report_clicks
integer

Report clicks

report_impressions
integer

Report impressions

report_visits
integer

Report visits

time_decay_1day_convs
float

Time decay model 1 day conversions

time_decay_1day_convs_per_1k_impress
float

Time decay model 1 day conversions per 1k impressions

time_decay_1day_convs_per_click
float

Time decay model 1 day conversions per click

time_decay_1day_convs_per_visit
float

Time decay model 1 day conversions per visit

time_decay_1day_cpa
float

Time decay model 1 day CPA

time_decay_1day_revenue
float

Time decay model 1 day revenue

time_decay_1day_roas
float

Time decay model 1 day ROAS

time_decay_7day_convs
float

Time decay model 7 day conversions

time_decay_7day_convs_per_1k_impress
float

Time decay model 7 day conversions per 1k impressions

time_decay_7day_convs_per_click
float

Time decay model 7 day conversions per click

time_decay_7day_convs_per_visit
float

Time decay model 7 day conversions per visit

time_decay_7day_cpa
float

Time decay model 7 day CPA

time_decay_7day_revenue
float

Time decay model 7 day revenue

time_decay_7day_roas
float

Time decay model 7 day ROAS

type
enum

The type of the campaign

Edges

EdgeDescription

Ad sets associated with the campaign

ID for the business unit associated with the campaign

Metrics broken down by dimensions

Validation Rules

ErrorDescription
270This Ads API request is not allowed for apps with development access level (Development access is by default for all apps, please request for upgrade). Make sure that the access token belongs to a user that is both admin of the app and admin of the ad account

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.