Overview
REMINDER: This endpoint is being deprecated by May 1, 2024! Please only use this for temporary reference and use the GraphQL V2 for new/updating queries!
The first version of our GraphQL API is being deprecated, but for the time being, we will retain the documentation here.
Data Limitations
The API will be rate limited to 5 requests every 1 second
Data from the Pulsar API is always delivered in JSON format.
The maximum results per page is 100, and a next token is available for paginated results.
Twitter
In accordance with our contract with Twitter, we are not able to use the API to provide any of the following pieces of information:
User Bio (the full bio of a user)
User Follower Count (total number of followers a user has)
User Coordinates (geolocated coordinates of a user)
Post Coordinate (geolocated coordinates of a post)
Keeping this in mind, this data is still accessible on platform, and you can still filter on user bio keywords when pulling posts using the API.
How to Use the GraphQL API
The first step is to talk to your account manager! They can help you get an API key as a demo or as part of your license, so that you and your team can begin testing the API. The API key is unique to each user’s access, so if you are on multiple subdomains on Pulsar, you will need a unique key for each subdomain you have access to. Note that if you already have an API key for the REST API, this is the same key you will use for the GraphQL API.
The next step is to find a testing environment. We hope to have an in-doc graph explorer available in the future where you can input your key and run sample calls for the GraphQL API. For now, we recommend a program like Insomnia for testing GraphQL API calls. This will allow you to see the schema dynamically while working on tests! The schema is incredibly important because it helps you understand all of the fields, subfields, and return types you can add to your call.
For GraphQL API access, make sure you:
Use the following subdomain exactly as the domain you're querying for TRAC (receiving data):
https://data-explorer.pulsarplatform.com/graphql/tracUse the following subdomain exactly as the domain you're querying for CORE:
https://data-explorer.pulsarplatform.com/graphql/coreUse the following subdomain exactly as the domain for using the Pusher API:
https://interaction-pusher.pulsarplatform.com/graphqlRemember to specify Authorization Bearer= "your token here" in your header. In Insomnia, there is a menu for selecting authorization method. Selecting Bearer and inputting your token in the first field should grant you access to the schema
Your API method must be POST whether you are using the pusher or data explorer. You specify in the body whether you are performing a query (for the data explorer) or a mutation (for the pusher)
Last updated
