Graph API Version

Offline Conversion Data Set Upload

Reading

A subset of Offline Event Data Set

Example

Graph API Explorer
GET /v10.0/{offline-conversion-data-set-upload-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(
    '/{offline-conversion-data-set-upload-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(
    "/{offline-conversion-data-set-upload-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{offline-conversion-data-set-upload-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{offline-conversion-data-set-upload-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

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

ID of the data set upload

api_calls
int32

Api calls stat from RTCS

creation_time
int32

Time of the creation of this upload tag

duplicate_entries
int32

Duplicate entries stat

event_stats
string

Event stats

event_time_max
integer

Latest entry timestamp

event_time_min
integer

First entry timestamp

first_upload_time
int32

Time of the first upload to this upload tag

is_excluded_for_lift
bool

The flag to determine if the upload data should be excluded from Lift

last_upload_time
int32

Time of the most recent upload to this upload tag

match_rate_approx
int32

Approximate match rate percentage for the entries in this upload

matched_entries
int32

Matched entries stat

upload_tag
string

The name by which uploads are grouped in this data set

valid_entries
int32

Valid entries stat

Edges

EdgeDescription

Upload progress, returns a list of progress ranges that were previously uploaded

Error Codes

ErrorDescription
294Managing advertisements requires an access token with the extended permission for ads_management

Creating

You can make a POST request to uploads edge from the following paths:
When posting to this edge, an OfflineConversionDataSetUpload will be created.

Parameters

ParameterDescription
upload_tag
UTF-8 encoded string

Upload tag string for each data set upload

Required

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Error Codes

ErrorDescription
21005Upload name exists
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.