Creating a report

Building a query

All the queries for the X Listening reports works in the same way.

You can submit a query object, containing a "raw" property, which it's the query to filter the tweets, for example

{
    "query": {
        "raw": "tweetbinder"
    }
}

It's going to filter the posts containing the word tweetbinder.

To learn more about operators, rule syntax, etc. you can check the X API Docs: https://developer.x.com/en/docs/x-api/tweets/search/integrate/build-a-query

Using dates

Include startDate and endDate in the queries to filter by dates. Use startDate to filter tweets newer that the provided date and endDate to filter tweets older.

You can use startDate and endDate in the same query.

You should format the dates using Unix time.

For example to get tweets from all the year 2023 you could do:

{
  "query": {
    "raw": "tweetbinder",
    "startDate": 1672531200,
    "endDate": 1704067200
  }
}

Limit parameter

To avoid run out your balance you can limit the total results of the search passing a limit. Keep in mind that this limit it's not strict. Depending on the X API we can give you between 1 and 15 more posts than the limit, but never less than it.

{
  "query": {
    "raw": "tweetbinder",
    "limit": 100
  }
}