Atlas API Version

Atlas Report Definition

Reading

An Atlas ReportDefinition

Examples

Graph API Explorer
GET v2.10/...?fields={fieldname_of_type_AtlasReportDefinition} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '...?fields={fieldname_of_type_AtlasReportDefinition}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "...?fields={fieldname_of_type_AtlasReportDefinition}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_AtlasReportDefinition}",
    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:@"...?fields={fieldname_of_type_AtlasReportDefinition}"
                                      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

This endpoint doesn't have any parameters.

Fields

FieldDescription

action_tags

List of actions performed on the ad by the user

attribution_config

Attribution configuration associated with the report definition

column_definitions

List of report column definition objects

columns

list<string>

List of column names

crosstab_columns

Cross tab columns associated with the report definition

date_range

Specifies the start and end date for fetching report results

filters

Parameters used to filter report results

include_empty_metric_rows

bool

Specifies if empty rows should be included in the report results

report_type

string

Type of the report

target_audience

AtlasTargetAudience

List of age range types and gender types a report is targeting at

time_zone

string

Time zone in which the report is run

Edges

No edges

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.