audience_sharing

List received audiences for a business

Changed on

Get a list of received audiences for the given business.

get/businesses/{business_id}/audiences

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

Query parameters

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "ad_account_id": "549755885175",
      "created_by_company_name": "Pinterest",
      "created_timestamp": 1451431341,
      "description": "People who love making quilts.",
      "id": "1234",
      "name": "ACME Tools",
      "rule": {
        "ad_account_id": "549755885175",
        "ad_id": [
          "687201361754"
        ],
        "campaign_id": [
          "626744528398"
        ],
        "country": "US",
        "customer_list_id": "5497558859876",
        "engagement_domain": [
          "www.somedomain.com"
        ],
        "engagement_type": "click",
        "engager_type": 1,
        "event": "checkout",
        "event_data": {
          "lead_type": "Newsletter",
          "line_items": {
            "product_brand": "Parker",
            "product_category": "Shoes",
            "product_id": 1414,
            "product_name": "Parker Boots",
            "product_price": "99.99",
            "product_quantity": 2,
            "product_variant": "Red",
            "product_variant_id": "1414-34832"
          },
          "order_id": "X-151481",
          "order_quantity": 1,
          "page_name": "Our Favorite Pins on Pinterest",
          "promo_code": "WINTER10",
          "property": "Athleta",
          "search_query": "boots",
          "value": "199.98",
          "video_title": "How to style your Parker Boots"
        },
        "event_source": {
          "=": [
            "web",
            "mobile"
          ]
        },
        "ingestion_source": {
          "=": [
            "tag"
          ]
        },
        "objective_type": [
          "AWARENESS"
        ],
        "percentage": 3,
        "pin_id": [
          "34567"
        ],
        "prefill": true,
        "retention_days": 30,
        "seed_id": [
          "2542620639259",
          "2542620639261"
        ],
        "visitor_source_id": "549755885175"
      },
      "size": 1000,
      "type": "audience",
      "updated_timestamp": 1451431341
    }
  ]
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from object to no type for status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      removed the ARS enum value from the ///// response property for the response status

    • info

      removed the AUD enum value from the ///// response property for the response status

    • info

      removed the BRL enum value from the ///// response property for the response status

    • info

      removed the CAD enum value from the ///// response property for the response status

    • info

      removed the CHF enum value from the ///// response property for the response status

    • info

      removed the CLP enum value from the ///// response property for the response status

    • info

      removed the COP enum value from the ///// response property for the response status

    • info

      removed the CZK enum value from the ///// response property for the response status

    • info

      removed the DKK enum value from the ///// response property for the response status

    • info

      removed the EUR enum value from the ///// response property for the response status

    • info

      removed the GBP enum value from the ///// response property for the response status

    • info

      removed the HKD enum value from the ///// response property for the response status

    • info

      removed the HUF enum value from the ///// response property for the response status

    • info

      removed the ILS enum value from the ///// response property for the response status

    • info

      removed the INR enum value from the ///// response property for the response status

    • info

      removed the JPY enum value from the ///// response property for the response status

    • info

      removed the KRW enum value from the ///// response property for the response status

    • info

      removed the MXN enum value from the ///// response property for the response status

    • info

      removed the NOK enum value from the ///// response property for the response status

    • info

      removed the NZD enum value from the ///// response property for the response status

    • info

      removed the PLN enum value from the ///// response property for the response status

    • info

      removed the RON enum value from the ///// response property for the response status

    • info

      removed the SEK enum value from the ///// response property for the response status

    • info

      removed the SGD enum value from the ///// response property for the response status

    • info

      removed the TRY enum value from the ///// response property for the response status

    • info

      removed the UNK enum value from the ///// response property for the response status

    • info

      removed the USD enum value from the ///// response property for the response status