What is the Reporting API?
The Collaboratory Reporting API allows your institution to automatically pull real-time data from your Collaboratory portal into your own internal tools — like dashboards, websites, or faculty reporting systems.
No more manual exports or copy-pasting data. With API access, your IT team can build connections that keep your data flowing smoothly and up to date.
💡 Think of it as a bridge or live data feed between Collaboratory and the systems (e.g., databases, webpages, data dashboards) your campus already uses.
What Can You Do With It?
You can use Collaboratory's API to:
Reduce manual work by feeding data into faculty reporting platforms or other institutional data systems or data lakes
Increase visibility by displaying your institution's community engagement on data dashboards or institutional, departmental, or faculty websites
Tell your story through custom data visualizations that highlight your campus' impact
Because Collaboratory collects unique data not found in other campus systems, integrating it creates a richer, more complete picture of your impact.
How It Works (high-level)
The Reporting API is like a live data feed from Collaboratory.
Just like a news ticker or stock market feed that sends live updates to your screen, Collaboratory’s API provides a real-time stream of your community engagement data. Your IT team can use this feed to pull data into other campus systems you already use — like dashboards, websites, or reporting tools.
This feed is powered by a technology called GraphQL, which gives developers a flexible way to request exactly the data they need — no more, no less.
To use the API, you’ll need someone on your campus with technical knowledge of APIs or web development.
🛠️ If you don’t know who this is, start by contacting your IT department — they’ll know what to do.
Technical Specifications
Feature | Details |
Protocol | GraphQL over HTTPS |
Authentication | API Key via X-Api-Key header plus access token |
Endpoint Structure | Single GraphQL endpoint with flexible query structure |
Data Format | JSON (native GraphQL response) |
Query Model | Read-only mutations (no data modification supported) |
Query Capabilities | Granular field selection, filtering, pagination, bulk retrieval |
Security | TLS 1.3 encryption in transit; institution-scoped data access |
Rate Limits | Configurable per institution (default: 10,000 queries/day) |
Data Freshness | Near real-time (<5 minute lag from source system) |
Schema Documentation | Full GraphQL introspection support; documentation portal available |
Before You Begin: Questions to Ask your IT Team
When determining institutional readiness and resources for an API integration, these questions can help guide your conversation with IT:
This will need a developer or systems analyst to connect Collaboratory’s API to our campus systems. Is there someone who could take that on?
How will integrating the API data into our existing systems (e.g., dashboards, data warehouses) fit into current IT project priorities?
If we decided to move forward, how much time would our IT team need to get it tested and running smoothly?
Who on our IT team would be responsible for maintaining the API connection over time, and how much effort would that require?
Once the connection is live, would anyone on our team need to check on it or make updates from time to time?
Does our IT team have the necessary skills with GraphQL and JSON, or will they need additional training to manage this API?
What You Need to Get Started
Here’s how to begin:
Connect with your IT team to identify who can identify a developer or technical contact
Contact your Collaboratory representative to request access and discuss subscription options
(API access requires an add-on subscription)Once approved, Collaboratory will provide:
Your secure API credentials
Developer documentation, including sample queries and use cases
Your IT team can begin development, pulling the exact data they need and integrating it into your desired systems
What Support is Available?
While the API is designed to be self-service, we’re here to help with:
Setting up and updating API credentials
Troubleshooting errors from API endpoints
Clarifying which endpoints to use for specific data
Answering general questions about features and functionality
⚠️ Your campus IT team will lead the setup and integration process.
Are There Any Limits?
To ensure smooth performance for all users:
API usage over 10,000 requests per day per institution may prompt a review and additional fees
We recommend scheduling regular data syncing outside business hours (8am–8pm ET)
Efficient use of the API (like batching and caching requests) helps avoid hitting these limits
Ready to Move Forward?
Reach out to your Collaboratory representative to:
Request API access
Explore subscription options
Get started with developer documentation
Have questions or want to explore possibilities before looping in IT? We’re happy to talk through it with you! Email [email protected] to start the conversation.