If you’re already a Pulsar API User, you’re probably familiar with our GraphQL API, which allows you to look for searches and pull data off platform with ease. If you haven’t yet used our API and you’re interested in customized platform automation, data aggregation off platform, and customized search creation without the need for a UI, now’s a great time to jump in!
With the new Pulsar GraphQL V2.0, we’re packing a bit of an upgrade to our already existing data pulls, as well as offering new mutation options to create searches, edit searches, create historics, preview historics, and launch data both historic and in real time!
Who is this for?
The Pulsar API is meant for users who want to access their Pulsar-Enriched data off-platform (e.g. custom databases, visualization programs like PowerBI, custom websites, etc.), or for users that wish to have non-UI mechanisms for accessing and creating searches on Pulsar.
The API is a fairly technical tool, so it is only recommended for clients that have access to development to build the connectors necessary to make full use of it. Pulsar is always happy to help support API queries but we’ll only be able to help you within the scope of our own API!
What’s the reason for this update?
The Pulsar API is always evolving, but GraphQL is actually newer territory for us! This meant that it took some work for us to understand the best way to go about using this formatting to provide access to our data. The second version of our GraphQL aims to correct some formatting to be more in-line with standard GraphQL formatting.
On top of this, the addition of a second TRAC endpoint provides an outlet for search creation which, before this update, was only possible on the old REST endpoint. Also, never before possible, we now allow you to create, preview, and launch historics all from the API! If it weren’t for the beautiful interface our product and engineering team have worked hard on, we’d almost tell you you’d never need to access the platform again!
What are these new endpoints?
TRAC Metadata Endpoint: https://trac.pulsarplatform.com/graphql - This endpoint is useful for collecting information on all the searches within your domain. This also allows you to create and edit searches, preview and launch historical data and start and stop real time searches.
Data Endpoint (TRAC): https://data.pulsarplatform.com/graphql/trac - This results endpoint allows you pull all the data from your TRAC searches.
Data Endpoint (CORE): https://data.pulsarplatform.com/graphql/core - This endpoint allows you to pull data from within CORE.
What do I need to do?
If you’re an existing Pulsar API user, you will receive a separate email announcing this release and a step by step guide on how you can migrate to v2.0. We will be sunsetting the Data-Explorer endpoint and the REST API on 30th June, meaning all queries need to be updated to reflect the new endpoints and syntax changes by then. If you’re worried about future changes, future versions of our API will be progressed under strict versioning, which will allow for multiple versions of the API to exist at the same time. Should you need any help with making the changes from v1.0 to v2.0, please do not hesitate to reach out to us on support@pulsarplatform.com.
Below is a brief overview of what you need to do:
Your existing API Bearer Token will not need re-issuing and can be used on the new endpoints.
Swap your old query endpoints with the new one relevant to your query.
Use the Schema (accessible via introspection query or a testing tool like Insomnia) to update any syntax as needed, for extra assistance, check out our one-page transition guide here!
Review the Pulsar API documentation here.
That’s it!
If you’re new to the Pulsar API and this latest version is something you will like to explore, then reach out to your Account Manager to help get you started.