search
Request an API keyBack to Craft.co

Getting started with JavaScript

Alerts API querying example with JavaScript

hashtag
Request code

To query the API, you can use any HTTP client of choice or any specialized GraphQL API Clients, like graphql-requestarrow-up-right, urqlarrow-up-right, or Apolloarrow-up-right.

Using a client compatible with Fetch APIarrow-up-right, the request could be issued with the following code:

circle-info

Make sure to replace <REPLACE_WITH_YOUR_KEY> with your unique API key.

const fetch = require('isomorphic-fetch');

const API_KEY = '<REPLACE_WITH_YOUR_KEY>';
const API_ENDPOINT = 'https://api.craft.co/v1/query';
const GRAPHQL_QUERY = /* GraphQL */`
    query getAlerts($first: Int!) { 
        alerts(first: $first) {
            id
            dataset
            variable
        }
    }
`;

requestHeaders = { 'Content-Type': 'application/json', 'x-craft-api-key': API_KEY };
requestData = { 'query': GRAPHQL_QUERY, 'variables': { 'first': 3 } };

const result = await fetch(API_ENDPOINT, {
    method: 'POST',
    headers: requestHeaders,
    body: JSON.stringify(requestData),
});

const { data, errors } = await result.json();

console.log(data);

hashtag
Response

The above command returns JSON structured like this:

hashtag
Read more

PreviousGetting startedNextGetting started with Python

Last updated

Was this helpful?