Publish the documentation
POST https://ads-api.twitter.com/7/stats/jobs/accounts/your_ads_account_id?end_time=&entity=&entity_ids=&granularity=&metric_groups=&placement=&start_time=
In addition to sharing API documentation privately, you can also share collections and environments publicly as web-viewable documentation. Documentation is based on a Qodex collection, so you can [generate it from an existing collection] or [create it in conjunction with a new collection] Here's some examples of good documentation collections:
- Ping Identity has a number of public APIs listed on their [Ping Identity team profile page] In the PingOne Platform APIs collection, endpoints are organized neatly into folders, markdown tables summarize required and optional variables, and technical diagrams provide a general overview for readers.
- Dropbox has a single documentation collection with workflows for team admins listed on their [Dropbox team profile page] This collection is unique in that it’s not intended for API reference, but rather for Dropbox team admins to execute specific workflows and tasks. The collection is kind of like an admin panel or internal tool, executing scripts in Qodex.
- Twitter has two profile pages for their [Developer Labs] and [Twitter Ads] teams. For the Twitter API v2, they’ve included examples demonstrating practical scenarios like 429 Rate limit exceeded
and 200 Request Tweet fields
. When you import this collection, you can also see a collection-level script that runs before every request in the collection to retrieve a Bearer token from the client credentials that you provide in your environment file.
- Rich Data Services provides a wealth of information with their data APIs, providing all the information you need to understand what is being offered with their COVID-19 APIs. Notice that every API request has a visualization displayed under the Visualize tab of the response body that guides you through how to use each individual API.
Body
PARAM
Key | Datatype | Required | Description |
end_time
|
null | ||
entity
|
null | ||
entity_ids
|
null | ||
granularity
|
null | ||
metric_groups
|
null | ||
placement
|
null | ||
Curl curl -X POST 'https://ads-api.twitter.com/7/stats/jobs/accounts/your_ads_account_id?end_time=&entity=&entity_ids=&granularity=&metric_groups=&placement=&start_time=?end_time=&entity=&entity_ids=&granularity=&metric_groups=&placement=&start_time=' ENDPOINTS |