IN THIS ARTICLE
How to access the API
   COMMAND LINE (CURL)
   PYTHON (with requests)
   JAVASCRIPT (with node's https)

Yellowdig's API allows you to pull fine-grained data—including attendance data, post and comment content, point-earning events, and other engagement metrics—from Communities to which you have access as an Owner, Facilitator, or Network Administrator.

Our detailed API documentation describes the endpoints and parameters that are available to you. We currently maintain three API routes: community/:community-id/events, network/:network-name/events, and community/:community-id/points. The events routes provide a time-ordered series of user events in a Community or Network based on the parameters you provide. Only Network Administrators can access the :network-name/events route. The :community-id/points route provides a detailed log of point-earning events in a Community based on the parameters you provide.


How to access the API

To consume the Yellowdig API, you will need to generate an API key. The amount of data to which you will have access is determined by the permissions and roles associated with your Yellowdig account.

To generate an API key, go to User Options → Account Settings → API Keys → GENERATE KEY. To copy your API key to the clipboard, click on the double paper icon.

Do not share your keys with anyone else. You are liable for protecting your API keys. To ensure data security, we recommend deleting keys you're no longer using by clicking the x button next to the key.

For more information on API routes and parameters, consult our API documentation. See below for samples of API calls in a few different languages: 

COMMAND LINE (CURL)

curl -H 'apikey: your_key'\ 
https://data.yellowdig.app/your_route_and_params

GIF showing curl API call and JSON result

PYTHON (with requests)

import requests
headers = {'apikey': 'your_key'}
requests.get('https://data.yellowdig.app/your_route_and_params', 
             headers=headers).json()

GIF showing Python API call and JSON result

JAVASCRIPT (with node's https)

const http = require('https');

let options = {
  host: 'data.yellowdig.app',
  path: 'your_route_and_params',
  headers: {'apikey': 'your_key'}
};

callback = function(response) {
  let str = '';
  response.on('data', function(chunk) {
    str += chunk;
  });
};

http.request(options, callback).end().data

GIF showing JavaScript API call and JSON result

Audience: This help article is for Instructors, Designers, and Administrators. Students or Learners cannot access these settings.

Was this article helpful?
0 out of 0 found this helpful