open-evolution icon indicating copy to clipboard operation
open-evolution copied to clipboard

Feature request: API v2 lookup context_annotations

Open edvilme opened this issue 2 years ago • 2 comments

The context_annotations field in tweets has extreme potential for us developers and researchers to understand the interests of a user, build communities, improve recommendation algorithms, etc, etc. As far as I understand, an entity has a unique id and can belong to one or many domains (please correct me if I'm wrong). I think an endpoint to get information about a specific entity would be very useful.

Eg: GET /2/context_annotations/entity/:id would return a JSON with the fields:

{
    "id": "XXXX", 
    "name": "XXXX", 
    "description": "XXXX", 
    "domains": [
         {
             "id": "XXXX",
             "name": "XXXX", 
             "description": "XXXX"
         }
    ] 
}

Could be future proof for things like associated_users or something like that. Thought about receiving some opinions and feedback before opening a formal request (as per the indications in README).

edvilme avatar Jul 17 '22 07:07 edvilme

Attachment: CSV of domains and entities As far as I understand, each entity can be associated to one or more domains.

edvilme avatar Jul 17 '22 07:07 edvilme

Thanks for the suggestion. As you've noted via the attachment, we're working to make the information available here via https://github.com/twitterdev/twitter-context-annotations but completely recognise that a callable API endpoint would be a useful addition to the platform.

I'm not currently able to confirm your understanding of whether entities can be a member of more than one domain, I'll see what I can find out there.

andypiper avatar Jul 20 '22 14:07 andypiper