https://github.com/xdevplatform/gnip-insights-interface

Interface to Twitter's Engagement API
https://github.com/xdevplatform/gnip-insights-interface

engagement-api python twitter

Last synced: about 8 hours ago
JSON representation

Interface to Twitter's Engagement API

• Host: GitHub
• URL: https://github.com/xdevplatform/gnip-insights-interface
• Owner: xdevplatform
• License: mit
• Created: 2016-09-06T21:08:50.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-03-08T18:44:10.000Z (over 3 years ago)
• Last Synced: 2024-10-03T16:22:59.123Z (about 1 month ago)
• Topics: engagement-api, python, twitter
• Language: Python
• Homepage:
• Size: 20.5 KB
• Stars: 31
• Watchers: 8
• Forks: 21
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: license

Awesome Lists containing this project

README

        
# Overview

This repository contains a Python package that provides an

interface to Twitter's

[Engagement API](https://developer.twitter.com/en/docs/twitter-api/enterprise/engagement-api/overview).  

In addition to providing a straightforward interface to the API, this package 

implements extra aggregation features. 

# Installation

You can pip-install the package:

`$ pip install gnip_insights_interface`

You can also install a local version from the cloned repository location.

`[REPOSITORY] $ pip install -e . -U`

# Credentials

This package expects to find a YAML credentials file called 

`.twitter_api_creds` in your home directory. This files must

contain your [Twitter Oauth credentials](https://dev.twitter.com/oauth/3-legged)

in the following format:

```

username: YOUR_USER_NAME

engagement:

    consumer_key: --

    consumer_secret: --

    token: --

    token_secret: --

    url: https://data-api.twitter.com/insights/engagement

```

# Engagement API Interface

We provide an interface for passing a set of Tweet IDs to the Twitter

Engagement API, which provides engagement data such as impressions, favorites,

and replies.  A full list of the available engagement types, their names, and

the ways that they can be grouped is available in the [API

documentation](https://developer.twitter.com/en/docs/twitter-api/enterprise/engagement-api/overview). 

We construct the API interface in a python module called `engagement_api`,

which is part of the `gnip_insights_interface` package.  We provide a script

for command-line interface called `tweet_engagements.py`.  The script provides

direct access the the three endpoint of the API: total counts (`-T`), 28 hour

summary (`-D`, for "day"), as well as an aggregating function (`-H`) which

combines the data from results over an arbitrary time range. See the help option.

Custom groupings and engagements types are set with a YAML configuration file

specified with the `-c` option. See example config in the `example` 

directory in the repository.