Graph API Version

Atlas Ad Set

Reading

An Atlas AdSet

Example

Graph API Explorer
GET /v8.0/{atlas-ad-set-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-ad-set-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-ad-set-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{atlas-ad-set-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-ad-set-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 ad set

alias
string

Alias given to the ad set

campaign

The campaign associated with the ad set

clicks
integer

Clicks count

connection

The connection this ad is tracked by

cost_per_1k_impressions
float

cost_per_1k_impressions

cost_per_click
float

cost_per_click

cost_per_visit
float

cost_per_visit

created_date
datetime

Date on which the ad set was created

data_driven_convs
float

data_driven_convs

data_driven_convs_per_100_clicks
float

data_driven_convs_per_100_clicks

data_driven_convs_per_1k_impress
float

data_driven_convs_per_1k_impress

data_driven_convs_per_click
float

data_driven_convs_per_click

data_driven_convs_per_visit
float

data_driven_convs_per_visit

data_driven_cpa
float

data_driven_cpa

data_driven_nullable_convs
float

data_driven_nullable_convs

data_driven_nullable_unattributed
float

data_driven_nullable_unattributed

data_driven_revenue
float

data_driven_revenue

data_driven_roas
float

data_driven_roas

data_driven_unattributed
float

data_driven_unattributed

even_credit_convs
float

even_credit_convs

even_credit_convs_per_100_clicks
float

even_credit_convs_per_100_clicks

even_credit_convs_per_1k_impress
float

even_credit_convs_per_1k_impress

even_credit_convs_per_click
float

even_credit_convs_per_click

even_credit_convs_per_visit
float

even_credit_convs_per_visit

even_credit_cpa
float

even_credit_cpa

even_credit_revenue
float

even_credit_revenue

even_credit_roas
float

even_credit_roas

even_credit_unattributed
float

even_credit_unattributed

first_click_convs
float

first_click_convs

first_click_convs_per_100_clicks
float

first_click_convs_per_100_clicks

first_click_convs_per_1k_impress
float

first_click_convs_per_1k_impress

first_click_convs_per_click
float

first_click_convs_per_click

first_click_convs_per_visit
float

first_click_convs_per_visit

first_click_cpa
float

first_click_cpa

first_click_revenue
float

first_click_revenue

first_click_roas
float

first_click_roas

first_click_unattributed
float

first_click_unattributed

first_touch_convs
float

first_touch_convs

first_touch_convs_per_100_clicks
float

first_touch_convs_per_100_clicks

first_touch_convs_per_1k_impress
float

first_touch_convs_per_1k_impress

first_touch_convs_per_click
float

first_touch_convs_per_click

first_touch_convs_per_visit
float

first_touch_convs_per_visit

first_touch_cpa
float

first_touch_cpa

first_touch_revenue
float

first_touch_revenue

first_touch_roas
float

first_touch_roas

first_touch_unattributed
float

first_touch_unattributed

last_click_convs
float

last_click_convs

last_click_convs_per_100_clicks
float

last_click_convs_per_100_clicks

last_click_convs_per_1k_impress
float

last_click_convs_per_1k_impress

last_click_convs_per_click
float

last_click_convs_per_click

last_click_convs_per_visit
float

last_click_convs_per_visit

last_click_cpa
float

last_click_cpa

last_click_revenue
float

last_click_revenue

last_click_roas
float

last_click_roas

last_click_unattributed
float

last_click_unattributed

last_click_with_extrapolation_convs
float

last_click_with_extrapolation_convs

last_click_with_extrapolation_convs_per_100_clicks
float

last_click_with_extrapolation_convs_per_100_clicks

last_click_with_extrapolation_convs_per_1k_impress
float

last_click_with_extrapolation_convs_per_1k_impress

last_click_with_extrapolation_convs_per_click
float

last_click_with_extrapolation_convs_per_click

last_click_with_extrapolation_convs_per_visit
float

last_click_with_extrapolation_convs_per_visit

last_click_with_extrapolation_cpa
float

last_click_with_extrapolation_cpa

last_click_with_extrapolation_revenue
float

last_click_with_extrapolation_revenue

last_click_with_extrapolation_roas
float

last_click_with_extrapolation_roas

last_click_with_extrapolation_unattributed
float

last_click_with_extrapolation_unattributed

last_modified_date
datetime

Date on which the ad set was last edited

last_touch_convs
float

last_touch_convs

last_touch_convs_per_100_clicks
float

last_touch_convs_per_100_clicks

last_touch_convs_per_1k_impress
float

last_touch_convs_per_1k_impress

last_touch_convs_per_click
float

last_touch_convs_per_click

last_touch_convs_per_visit
float

last_touch_convs_per_visit

last_touch_cpa
float

last_touch_cpa

last_touch_revenue
float

last_touch_revenue

last_touch_roas
float

last_touch_roas

last_touch_unattributed
float

last_touch_unattributed

last_touch_with_extrapolation_convs
float

last_touch_with_extrapolation_convs

last_touch_with_extrapolation_convs_per_100_clicks
float

last_touch_with_extrapolation_convs_per_100_clicks

last_touch_with_extrapolation_convs_per_1k_impress
float

last_touch_with_extrapolation_convs_per_1k_impress

last_touch_with_extrapolation_convs_per_click
float

last_touch_with_extrapolation_convs_per_click

last_touch_with_extrapolation_convs_per_visit
float

last_touch_with_extrapolation_convs_per_visit

last_touch_with_extrapolation_cpa
float

last_touch_with_extrapolation_cpa

last_touch_with_extrapolation_revenue
float

last_touch_with_extrapolation_revenue

last_touch_with_extrapolation_roas
float

last_touch_with_extrapolation_roas

last_touch_with_extrapolation_unattributed
float

last_touch_with_extrapolation_unattributed

name
string

Name of the ad set

net_media_cost
float

net_media_cost

positional_30fl_convs
float

positional_30fl_convs

positional_30fl_convs_per_100_clicks
float

positional_30fl_convs_per_100_clicks

positional_30fl_convs_per_1k_impress
float

positional_30fl_convs_per_1k_impress

positional_30fl_convs_per_click
float

positional_30fl_convs_per_click

positional_30fl_convs_per_visit
float

positional_30fl_convs_per_visit

positional_30fl_cpa
float

positional_30fl_cpa

positional_30fl_revenue
float

positional_30fl_revenue

positional_30fl_roas
float

positional_30fl_roas

positional_30fl_unattributed
float

positional_30fl_unattributed

positional_40fl_convs
float

positional_40fl_convs

positional_40fl_convs_per_100_clicks
float

positional_40fl_convs_per_100_clicks

positional_40fl_convs_per_1k_impress
float

positional_40fl_convs_per_1k_impress

positional_40fl_convs_per_click
float

positional_40fl_convs_per_click

positional_40fl_convs_per_visit
float

positional_40fl_convs_per_visit

positional_40fl_cpa
float

positional_40fl_cpa

positional_40fl_revenue
float

positional_40fl_revenue

positional_40fl_roas
float

positional_40fl_roas

positional_40fl_unattributed
float

positional_40fl_unattributed

report_click_through_rate
float

report_click_through_rate

report_clicks
integer

report_clicks

report_impressions
integer

report_impressions

report_visits
integer

report_visits

search_clicks
integer

Search clicks count

time_decay_1day_convs
float

time_decay_1day_convs

time_decay_1day_convs_per_100_clicks
float

time_decay_1day_convs_per_100_clicks

time_decay_1day_convs_per_1k_impress
float

time_decay_1day_convs_per_1k_impress

time_decay_1day_convs_per_click
float

time_decay_1day_convs_per_click

time_decay_1day_convs_per_visit
float

time_decay_1day_convs_per_visit

time_decay_1day_cpa
float

time_decay_1day_cpa

time_decay_1day_revenue
float

time_decay_1day_revenue

time_decay_1day_roas
float

time_decay_1day_roas

time_decay_1day_unattributed
float

time_decay_1day_unattributed

time_decay_7day_convs
float

time_decay_7day_convs

time_decay_7day_convs_per_100_clicks
float

time_decay_7day_convs_per_100_clicks

time_decay_7day_convs_per_1k_impress
float

time_decay_7day_convs_per_1k_impress

time_decay_7day_convs_per_click
float

time_decay_7day_convs_per_click

time_decay_7day_convs_per_visit
float

time_decay_7day_convs_per_visit

time_decay_7day_cpa
float

time_decay_7day_cpa

time_decay_7day_revenue
float

time_decay_7day_revenue

time_decay_7day_roas
float

time_decay_7day_roas

time_decay_7day_unattributed
float

time_decay_7day_unattributed

Edges

EdgeDescription

Metrics broken down by dimensions

Validation Rules

ErrorDescription
100Invalid parameter

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.