Facebook Audiences: Most-used fields

Facebook Audiences: Most-used fields#

The table below gives information about most-used fields that you can import from Facebook Audiences. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

account_id

account_id

The unique identifier for the ad account associated with the audience.

dimension

account_name

account_name

The name of the Facebook Ad Account or Business Account associated with the audience.

dimension

approximate_count

approximate_count

An estimated number of people included in the audience.

metric

approximate_count_lower_bound

approximate_count_lower_bound

The estimated lower bound of the number of people in the audience.

metric

approximate_count_upper_bound

approximate_count_upper_bound

The upper bound of the approximate number of people in this audience. Returns -1 for inactive lookalike audiences.

metric

audience_type

audience_type

A classification indicating whether the audience is a ‘Custom Audience’ or a ‘Saved Audience’, added by the data integration platform for differentiation.

dimension

data_source.sub_type

data_source.sub_type

The specific method or source from which the custom audience was created, such as ‘CUSTOMER_FILE’ for customer lists or ‘WEBSITE’ for website visitors. Some subtypes are only creatable via Ads Manager.

dimension

data_source.type

data_source.type

The general category of the data source used to create the audience, derived from the original data source.

dimension

description

description

A descriptive text provided by the user for the audience, often used to explain its purpose or criteria.

dimension

external_event_source.id

external_event_source.id

The unique identifier of the Facebook Pixel or other event source whose traffic generated the custom audience.

metric

id

id

The unique identifier for the audience.

dimension

is_value_based

is_value_based

Indicates whether the custom audience is a value-based audience, which includes an arbitrary numeric value for each user to determine their worth.

dimension

lookalike_audience_ids

lookalike_audience_ids

A list of unique identifiers for lookalike audiences that were generated from this custom audience.

dimension

lookalike_spec

lookalike_spec

A JSON object defining the specifications for a Lookalike Audience, including parameters like type (e.g., ‘reach’), ratio (audience size percentage), and location targeting.

dimension

name

name

The name of the audience, used for identification and display.

dimension

pixel_id

pixel_id

The ID of the Facebook Pixel whose traffic contributed to generating this website custom audience.

dimension

report_date

report_date

The date when the audience metadata and metrics were reported by the data integration platform, as historical date ranges are not supported by the API for audience metrics.

dimension

retention_days

retention_days

The number of days to retain a user in the custom audience. This value can range from 1 to 180 days. If not specified, the audience members are retained indefinitely. This field is primarily available for Customer File Custom Audiences.

metric

rule

rule

A JSON object defining the rules applied to create or filter the audience, especially for website custom audiences, product audiences, or video remarketing audiences.

dimension

subtype

subtype

The specific subtype of the audience, such as ‘CUSTOM’ for custom audiences or ‘LOOKALIKE’ for lookalike audiences.

dimension

time_content_updated

time_content_updated

The timestamp indicating the last time the audience’s content, such as the list of included people, was updated. This field is primarily supported for Customer List Custom Audiences.

dimension

time_created

time_created

The timestamp indicating when the audience was created.

dimension

time_updated

time_updated

The timestamp indicating when the audience object was last updated or modified.

dimension