Getting started

​

What you’ll need

• Base URL:
  POST https://cumtxmqb68.execute-api.us-west-2.amazonaws.com/staging/v1.0.0/graphql
  
• API key to include in the request headers: x-api-key: YOUR_API_KEY
  The Learning Commons team will securely share an API key for the GraphQL endpoint with you separately.
• For Python: gql for better GraphQL support, schema validation, and error handling
  pip install gql[requests]
  

​

Query the data

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{"query":"{ courses(limit: 5) { identifier name academicSubject } }"}' \
  https://cumtxmqb68.execute-api.us-west-2.amazonaws.com/staging/v1.0.0/graphql

import os
from gql import Client, gql
from gql.transport.requests import RequestsHTTPTransport

# Setup client
transport = RequestsHTTPTransport(
    url="https://cumtxmqb68.execute-api.us-west-2.amazonaws.com/staging/v1.0.0/graphql",
    headers={"x-api-key": os.getenv("API_KEY")},  # Your API key
    use_json=True,
)

client = Client(transport=transport, fetch_schema_from_transport=False)

# Execute query
query = gql("""
{
  courses(limit: 5) {
    identifier
    name
    academicSubject
  }
}
""")

result = client.execute(query)
print(result)

const url =
  "https://cumtxmqb68.execute-api.us-west-2.amazonaws.com/staging/v1.0.0/graphql";
const apiKey = process.env.API_KEY; // Your API key

const query = `
{
  courses(limit: 5) {
    identifier
    name
    academicSubject
  }
}
`;

fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": apiKey,
  },
  body: JSON.stringify({ query }),
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

​

Troubleshooting

​

Query too complex

• Reduce the depth of nested relationships
• Implement pagination on nested connections
• Split complex queries into multiple simpler ones

​

No results returned

• Check filter conditions are correct
• Verify field names match the schema
• Use introspection queries to explore available fields

​

Authentication errors

• Ensure your API key is valid and active
• Check that the x-api-key header is properly set

​

Rate limiting

• 2 requests per second with burst capacity up to 10 requests
• Exponential backoff when receiving rate limit errors (HTTP 429: Too Many Requests)

​

Server errors

• Reduce page size to fewer than 1000 items
• Retry the query

​

Payload and timeout limits

• Request timeout: 30 sec
• Request payload size: 10 MB
• Response payload size: 6 MB
• Query complexity: Deeply nested queries may hit processing limits

• Use pagination for large result sets
• Limit field selection to only required data
• Avoid deeply nested queries (>5 levels)
• Break up complex queries or add filtering (e.g., grade level or subject)

​

GraphQL errors

{
  "errors": [
    {
      "message": "Field 'invalidField' doesn't exist on type 'Lesson'",
      "locations": [{"line": 2, "column": 5}]
    }
  ]
}

​

Related topics