PIpinterest
audience_insights

Get audience insights

Changed on

Get Audience Insights for an ad account. The response will return insights for 3 types of audiences: the ad account's engaged audience on Pinterest, the ad account's total audience on Pinterest and Pinterest's total audience.

Learn more about Audience Insights.

get/ad_accounts/{ad_account_id}/audience_insights

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

audience_insight_type'YOUR_TOTAL_AUDIENCE' | 'YOUR_ENGAGED_AUDIENCE' | 'PINTEREST_TOTAL_AUDIENCE' required
Example:YOUR_TOTAL_AUDIENCE

Type of audience insights.

Response

The request has succeeded.

datestring nullable

Generation date

sizeinteger

Population count.

size_is_upper_boundboolean

Indicates whether the audience size has been rounded up to the next highest upper boundary.

type'YOUR_TOTAL_AUDIENCE' | 'YOUR_ENGAGED_AUDIENCE' | 'PINTEREST_TOTAL_AUDIENCE'

Example response

{
  "categories": [
    {
      "id": "1234567",
      "index": 1.2,
      "key": "1234567",
      "name": "travel",
      "ratio": 0.551
    }
  ],
  "date": "2022-10-09",
  "demographics": {
    "ages": [
      {
        "name": "United States",
        "key": "us",
        "ratio": 0.551
      }
    ],
    "countries": [
      {
        "name": "United States",
        "key": "us",
        "ratio": 0.551
      }
    ],
    "devices": [
      {
        "name": "United States",
        "key": "us",
        "ratio": 0.551
      }
    ],
    "genders": [
      {
        "name": "United States",
        "key": "us",
        "ratio": 0.551
      }
    ],
    "metros": [
      {
        "name": "United States",
        "key": "us",
        "ratio": 0.551
      }
    ]
  },
  "size": 10000,
  "size_is_upper_bound": true,
  "type": "YOUR_TOTAL_AUDIENCE"
}

Changes

  • v5b698c180678aRevision changes
    • 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 non-success response with the status

    • info

      the response's property default value YOUR_TOTAL_AUDIENCE was removed for the status

  • v510f9eba4ad97Revision changes
    • info

      the endpoint scheme security client_credentials was added to the API