Skip to main content
Version: v3

Get custom audience by ID

GET 

/ad-publishing/facebook/custom-audience/:audienceId

Retrieve one custom audience with its full detail. Returns more than the listing endpoint: Meta adds the fields relevant to the audience subtype (retentionDays and customerFileSource for customer lists, rule and pixelId for website audiences, lookalikeSpec for lookalikes), and this service appends extras describing the local smart-list or CSV source when the audience is a user-provided customer list.

Request

Version stringrequired

API Version

Available optionsv3
audienceId stringrequired

Custom audience identifier

locationId stringrequired

Location identifier

application/json

The audience with the fields relevant to its subtype

Schema
    idstring

    Audience id

    namestring

    Audience name

    descriptionstring

    Audience description. Empty string when not set.

    subtypestring

    How the audience was built. LOOKALIKE for lookalikes; CUSTOM, ENGAGEMENT, WEBSITE, and LEAD for the rest.

    approximateCountLowerBoundnumber

    Lower bound of the audience size. Facebook floors small audiences — 1000 and 20 are placeholders, not counts.

    approximateCountUpperBoundnumber

    Upper bound of the audience size

    deliveryStatusobject

    Whether the audience can be used in a campaign right now

    operationStatusobject

    Whether Facebook is still building or refreshing the audience

    dataSourceobject

    Where the audience gets its members from

    timeCreatednumber

    Creation time as a Unix timestamp in seconds, not milliseconds and not ISO-8601.

    timeUpdatednumber

    Last update time as a Unix timestamp in seconds. Equals timeCreated when never edited.

    customerFileSourcestring

    How the member list was supplied. Present on customer-list audiences.

    retentionDaysnumber

    How long a member stays in the audience. 0 means members never expire.

    ruleobject

    Matching rule for a website audience, as Meta returns it. Structure varies with the rule and is passed through unchanged.

    pixelIdstring

    Pixel backing a website audience

    lookalikeSpecobject

    Seed and ratio settings for a lookalike audience, passed through from Meta

    lookalikeAudienceIdsstring[]

    Ids of lookalikes derived from this audience

    extrasobject

    Local sourcing metadata. Added by this service only for user-provided customer lists that have a matching local record; absent otherwise.