Reach and Average Frequency

GET stats/accounts/:account_id/reach/campaigns

Retrieve reach and average frequency analytics for specified campaigns.

Resource URL

https://ads-api.twitter.com/stats/accounts/:account_id/reach/campaigns

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

campaign_ids
required

Scope the response to just the desired campaigns by specifying a comma-separated list of identifiers. Up to 20 IDs may be provided.

Note: Up to 20 campaign IDs may be provided.

Type: string

Example: 8fgzf

end_time
required

Scopes the retrieved data to the specified end time, expressed in ISO 8601.

Note: Must be expressed in whole hours (0 minutes and 0 seconds).

Type: string

Example: 2017-05-26T07:00:00Z

start_time
required

Scopes the retrieved data to the specified start time, expressed in ISO 8601.

Note: Must be expressed in whole hours (0 minutes and 0 seconds).

Type: string

Example: 2017-05-19T07:00:00Z

Example Request

GET https://ads-api.twitter.com/8/stats/accounts/18ce54d4x5t/reach/campaigns?campaign_ids=8fgzf&start_time=2017-05-19&end_time=2017-05-26

Example Response

{
  "request": {
    "params": {
      "campaign_ids": [
        "8fgzf"
      ],
      "start_time": "2017-05-19T00:00:00Z",
      "end_time": "2017-05-26T00:00:00Z",
      "account_id": "18ce54d4x5t"
    }
  },
  "data_type": "reach",
  "data": [
    {
      "id": "8fgzf",
      "total_audience_reach": 1217,
      "average_frequency": 1.01
    }
  ]
}

GET stats/accounts/:account_id/reach/funding_instruments

Retrieve reach and average frequency analytics for specified funding instruments.

Resource URL

https://ads-api.twitter.com/stats/accounts/:account_id/reach/funding_instruments

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

funding_instrument_ids
required

Scope the response to just the desired funding instruments by specifying a comma-separated list of identifiers. Up to 20 IDs may be provided.

Note: Up to 20 funding instrument IDs may be provided.

Type: string

Example: lygyi

end_time
required

Scopes the retrieved data to the specified end time, expressed in ISO 8601.

Note: Must be expressed in whole hours (0 minutes and 0 seconds).

Type: string

Example: 2017-05-26T07:00:00Z

start_time
required

Scopes the retrieved data to the specified start time, expressed in ISO 8601.

Note: Must be expressed in whole hours (0 minutes and 0 seconds).

Type: string

Example: 2017-05-19T07:00:00Z

Example Request

GET https://ads-api.twitter.com/8/stats/accounts/18ce54d4x5t/reach/funding_instruments?funding_instrument_ids=lygyi&start_time=2017-05-19&end_time=2017-05-26

Example Response

{
  "request": {
    "params": {
      "funding_instrument_ids": [
        "lygyi"
      ],
      "start_time": "2017-05-19T00:00:00Z",
      "end_time": "2017-05-26T00:00:00Z",
      "account_id": "18ce54d4x5t"
    }
  },
  "data_type": "reach",
  "data": [
    {
      "id": "lygyi",
      "total_audience_reach": 1217,
      "average_frequency": 1.01
    }
  ]
}

Was this document helpful?

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?

Thank you for the feedback. Your comments will help us improve our documents in the future.