Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Full documentation for the Skylight GraphQL API can be found here: http://api.skylight.earth/schema/query.doc.html

Getting Started

After opening Postman, you want to import the environment variables file and the collections that contains the sample queries

Importing Environment Variables

Our sample file uses environment variable so that you can pass in URL and access token for different queries instead of entering them manually for each query. We created the file for you to get started.

...

You will see the {{base_url}} and {{access_token}}

...


Importing the Collection

  1. Click on Collections

  2. Import the *.postman_collection.json. You will see the GraphQL collection added to the list.

...

Running the Queries

Before running the query, you need to set your environment. Click on the “No environment” drop down as shown below and select the environment file you imported.

...

You will see a Postman query for "events" below. This query can be used to return all event types, although in our example we will be returning only Dark and Standard Rendezvous.

...

Input Fields

For our example we will run a query that returns Dark Rendezvous and Standard Rendezvous events between May 1, 2023 and May 2, 2023. The results will be limited to only 1 page where each page returns 5 events. The following arguments are used to filter the results:

...

One of the arguments used in the sample query is eventType. This filter is a list that contains a pre-defined value. Since we want to get a list of Dark Rendezvous and Standard Rendezvous events, we need to look at eventTypes to see the value assigned for this object. You will see “dark_rendezvous” and “standard_rendezvous” are the two values we need for our query.

...

Output Fields

With GraphQL you can select from all fields which need to be returned. For this query example we want this information:

...

Running the query gives a response similar to the below:

Event Type Specific Response

Response fields in Event and EventDetails might be tied to a specific event type hence it will only return a result when your arguments is containing that event. Below is the matrix of fields:

...