A Facebook pixel is a small piece of JavaScript code that an advertiser places on every page of their website. This piece of code provides a set of lightweight functionalities for sending user-specific events and event-specific custom data to Facebook. Advertisers can use the Facebook pixel to capture intent information about how people are using their website. A single Facebook pixel is added to all pages of a website, and is then used to create website custom audiences
GET /v20.0/{ads-pixel-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(
'/{ads-pixel-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(
"/{ads-pixel-id}",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{ads-pixel-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:@"/{ads-pixel-id}"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Field | Description |
---|---|
id
numeric string
|
ID of the pixel |
automatic_matching_fields
list<enum>
|
Advanced matching fields which are enabled for automatic advanced matching |
can_proxy
bool
|
can_proxy |
code
string
|
Pixel code to be placed on the website |
string
|
The configuration to use for uploads to this dataset. Format determined by the method of upload (eg. UI or SDK) |
creation_time
datetime
|
Time at which the pixel was created |
creator
|
The user who created this pixel |
data_use_setting
enum
|
Setting to capture how pixel data should be used |
string
|
SELF_EXPLANATORY |
integer
|
Number of duplicate entries for this dataset |
bool
|
Whether the dataset is auto assigned and auto tracked for all accounts that the owner business owns |
enable_automatic_matching
bool
|
Represents whether automatic advanced matching is enabled for the pixel for identity matching purposes |
string
|
Event stats of this dataset |
integer
|
Latest entry of this dataset |
integer
|
Earliest entry of this dataset |
first_party_cookie_status
enum
|
First party cookie status to indicate whether first party cookies can be set for this pixel |
has_1p_pixel_event
bool
|
whether pixel has sent us 1p signals |
bool
|
A boolean value indicating whether this signal container has unified pixel and offline conversion data set |
is_created_by_business
bool
|
Flag stands for if a pixel is created by business |
is_crm
bool
|
True if a pixel contains lead gen data source config |
bool
|
Whether the dataset is restricted to MTA only |
bool
|
Whether the dataset is restricted to Lift only |
is_unavailable
bool
|
Whether this pixel is unavailable |
last_fired_time
datetime
|
Time at which the pixel was last fired |
string
|
The app that made the most recent upload |
integer
|
Time when the app that made the most recent upload last changed |
int32
|
Approximate match rate percentage for the entries in this dataset |
integer
|
Number of matched entries of this dataset |
name
string
|
Name of the pixel |
owner_business
|
ID of the business that owns this pixel or null if the pixel has not been claimed by any business yet. |
OfflineConversionDataSetUsage
|
Usage info for the dataset |
integer
|
Number of valid entries of this dataset |
Edge | Description |
---|---|
Edge<AssignedUser>
|
assigned_users |
Edge<DACheck>
|
A list of results after running Dynamic Ads checks on this pixel. |
Edge<OfflineConversionDataSetUpload>
|
The offline uploads associated with this event set |
Edge<OpenBridgeConfiguration>
|
Get all the openbridge configurations associated to this Pixel |
Edge<Business>
|
Agencies or other businesses this pixel is shared with |
Edge<AdsPixelStatsResult>
|
Stats data for this pixel |
Error | Description |
---|---|
200 | Permissions error |
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
190 | Invalid OAuth 2.0 Access Token |
2500 | Error parsing graph query |
adspixels
edge from the following paths:
POST /v20.0/act_<AD_ACCOUNT_ID>/adspixels HTTP/1.1
Host: graph.facebook.com
name=My+WCA+Pixel
/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->post(
'/act_<AD_ACCOUNT_ID>/adspixels',
array (
'name' => 'My WCA Pixel',
),
'{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(
"/act_<AD_ACCOUNT_ID>/adspixels",
"POST",
{
"name": "My WCA Pixel"
},
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
Bundle params = new Bundle();
params.putString("name", "My WCA Pixel");
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/act_<AD_ACCOUNT_ID>/adspixels",
params,
HttpMethod.POST,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
NSDictionary *params = @{
@"name": @"My WCA Pixel",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/act_<AD_ACCOUNT_ID>/adspixels"
parameters:params
HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
curl -X POST \
-F 'name="My WCA Pixel"' \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v20.0/act_<AD_ACCOUNT_ID>/adspixels
Parameter | Description |
---|---|
name
string
|
Name of the pixel |
id
in the return type.id
: numeric string,Error | Description |
---|---|
6202 | More than one pixel exist for this account |
100 | Invalid parameter |
6200 | A pixel already exists for this account |
190 | Invalid OAuth 2.0 Access Token |
200 | Permissions error |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
/{ads_pixel_id}
. Parameter | Description |
---|---|
automatic_matching_fields
array<enum {em, fn, ln, ph, ge, zp, ct, st, country, db, external_id}>
|
Advanced matching fields for which automatic advanced matching should be enabled |
data_use_setting
enum {EMPTY, ADVERTISING_AND_ANALYTICS, ANALYTICS_ONLY}
|
Setting to capture how pixel data should be used |
enable_automatic_matching
boolean
|
Enable automatic advanced matching for the pixel for identity matching purposes |
first_party_cookie_status
enum {EMPTY, FIRST_PARTY_COOKIE_ENABLED, FIRST_PARTY_COOKIE_DISABLED}
|
First party cookie status to indicate whether first party cookies can be set for this pixel |
name
string
|
Name of the pixel |
server_events_business_ids
array<numeric string>
|
server_events_business_ids |
success
: bool,Error | Description |
---|---|
190 | Invalid OAuth 2.0 Access Token |
100 | Invalid parameter |