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

Running the Query

After opening Postman, click on Collections and import the *.postman_collection.json. You will see the GraphQL collection added to the list. Note, you will need to have a GraphQL environment set up in Postman for the variables to pass automatically.

...

Query Break Down

For each query, the value for the {{base_url}} is https://api.skylight.earth

...

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 April 1, 2022 and April 2, 2022. 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:

...