Skip to content

Commit b551611

Browse files
authored
Update overview.md
1 parent 37ed720 commit b551611

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

documentation/api/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,14 +150,14 @@ Please see the API spec for this endpoint at [X Developer API guide: Evaluate a
150150
Example request to retrieve the last 10 eligible posts, in test mode, and requesting all the same fields the [Template API Note Writer](https://github.com/twitter/communitynotes/tree/main/template-api-note-writer) uses:
151151
```
152152
curl --request GET \
153-
--url https://api.twitter.com/2/notes/search/posts_eligible_for_notes?test_mode=true&max_results=10&tweet.fields=author_id,created_at,referenced_tweets,media_metadata,suggested_source_links&expansions=attachments.media_keys,referenced_tweets.id,referenced_tweets.id.attachments.media_keys&media.fields=alt_text,duration_ms,height,media_key,preview_image_url,public_metrics,type,url,width,variants \
153+
--url https://api.twitter.com/2/notes/search/posts_eligible_for_notes?test_mode=true&max_results=10&tweet.fields=author_id,created_at,referenced_tweets,media_metadata,suggested_source_links_with_counts&expansions=attachments.media_keys,referenced_tweets.id,referenced_tweets.id.attachments.media_keys&media.fields=alt_text,duration_ms,height,media_key,preview_image_url,public_metrics,type,url,width,variants \
154154
--header 'Authorization: Bearer <token>'
155155
```
156156
The output will have:
157157
* A `data` field:
158158
* one item per post (tweet), including the requested fields specified by `tweet.fields` (`id`, `text`, `author_id`,...)
159159
* Note that if a post exceeds 280 chars, its full text will be stored in the `note_tweet` field rather than text
160-
* `suggested_source_links` contains URLs for X posts that were suggested as potential sources by people who requested a Community Note on the post
160+
* `suggested_source_links_with_counts` contains URLs for X posts that were suggested as potential sources by people who requested a Community Note on the post, it also contains the number of times each URL was suggested by different people.
161161
* An `includes` field:
162162
* a field called `media`, which contains media information for all media that appears in any post returned in this reference. it can be looked up with `media_key`.
163163
* a field called `tweets`, which contains all referenced posts that aren't the eligible posts themselves (e.g. posts that were quoted by or replied-to by the eligible post)

0 commit comments

Comments
 (0)