Insights

GET insights/accounts/account_id

Retrieve insights for specific account.

See GET insights/accounts/:account_id/available_audiences for audience sets available for a given ads account. Please note that availability of audiences will vary across ads accounts.

Resource URL

https://ads-api.twitter.com/3/insights/accounts/:account_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

audience_type
required

The audience or set of people you’d like more insights on.

Type: enum

Possible Values: ALL_ON_TWITTER, APP, CAMPAIGN, ORGANIC

audience_values
sometimes required

The identifier of the available audience set requested. Availability depends on the audience_type.

Type: string

Example: 702

interaction_type
sometimes required

The type of interaction captured for the available audience set requested. on the audience_type.

Type: enum

Possible Values: CONVERSION, ENGAGEMENT, IMPRESSION

Example Request

GET https://ads-api.twitter.com/3/insights/accounts/18ce54d4x5t?audience_type=ALL_ON_TWITTER

Example Response

{
  "data": {
    "home_value": {
      "results": [
        {
          "name": "Home value: $99,999 and under",
          "value": "Home value: $99,999 and under",
          "percentage": 12
        },
        {
          "name": "Home value: $300,000 - $499,000",
          "value": "Home value: $300,000 - $499,000",
          "percentage": 19.8
        },
        {
          "name": "Home value: $500,000 and higher",
          "value": "Home value: $500,000 and higher",
          "percentage": 11.86
        },
        {
          "name": "Home value: $100,000 - $199,000",
          "value": "Home value: $100,000 - $199,000",
          "percentage": 33.78
        },
        {
          "name": "Home value: $200,000 - $299,000",
          "value": "Home value: $200,000 - $299,000",
          "percentage": 22.57
        }
      ],
      "match_rate": 43.3,
      "source": "Datalogix"
    },
    ...,
    "occupation": {
      "results": [
        {
          "name": "White collar worker",
          "value": "White collar worker",
          "percentage": 14.1
        },
        ...
      ],
      "match_rate": 22.6,
      "source": "Datalogix"
    }
  },
  "request": {
    "params": {
      "audience_type": "ALL_ON_TWITTER",
      "account_id": "18ce54d4x5t"
    }
  }
}

GET insights/accounts/:account_id/available_audiences

Retrieve available audiences for this account.

Resource URL

https://ads-api.twitter.com/3/insights/accounts/:account_id/available_audiences

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

Example Request

GET https://ads-api.twitter.com/3/insights/accounts/18ce54d4x5t/available_audiences

Example Response

{
  "data": [
    {
      "audience_type": "ALL_ON_TWITTER"
    },
    {
      "audience_type": "ORGANIC",
      "interaction_types": [
        "IMPRESSION"
      ],
      "audience_value": "2417045708"
    }
  ],
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  }
}