General | API Overview
Welcome to the Cyclopt API! This guide provides an overview of the API's capabilities, including how to interact with various endpoints, authentication requirements, pagination controls, and handling of common response formats and errors.
Features:
- Analyses: Retrieve detailed analysis data for commits, repositories by their ID, or by owner and repository name.
- Projects: Access and manage project-specific information and tasks.
- Repositories: Interact with repository data, including commit history and analytics.
- Teams: Manage and retrieve detailed team information.
Authentication:
All endpoints require an authorization token to access. Ensure you include a valid token in the headers of your requests:
Pagination:
Many endpoints that return lists support pagination to manage data flow and optimize client-side data handling. Pagination is controlled via page
and limit
query parameters. Responses may include next
and prev
links to aid in navigation between results pages.
Authorization Header
Field | Type | Description |
---|---|---|
x-access-cyclopt-token required | String |
Authorization token required for accessing the API. |
Pagination Query Parameters
Field | Type | Description |
---|---|---|
page optional | Number |
The page number to access. Default value: |
limit optional | Number |
The maximum number of records to return per page. Default value: |
Success 200
Field | Type | Description |
---|---|---|
next required | String |
URL to the next page of results, if available. |
prev required | String |
URL to the previous page of results, if available. |