Skip to main content
POST
/
api
/
metrics
/
developer
/
summary
/
get
curl --request POST \
  --url https://api.codeant.ai/api/metrics/developer/summary/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "platform": "github",
  "org": "my-org",
  "author": "janedoe",
  "repositories": [
    "my-org/backend-api"
  ],
  "start_date": "2025-01-01",
  "end_date": "2025-03-01"
}
'
{
  "metric": "dev_summary",
  "platform": "<string>",
  "org": "<string>",
  "author": "<string>",
  "repositories": [
    "<string>"
  ],
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "summary": "<string>",
  "pr_descriptions": [
    "<string>"
  ],
  "execution_time": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.codeant.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Access token for the git provider (GitHub PAT, GitLab PAT, Bitbucket App Password, Azure DevOps PAT). Pass via Authorization: Bearer <token> header.

Body

application/json
​
platform
enum<string>
required

Version control platform

Available options:
github,
gitlab,
bitbucket,
azure_devops,
azuredevops
Example:

"github"

​
org
string
required

Organization, workspace, or group name on the platform

Example:

"my-org"

​
start_date
string<date>
required

Start of the date range (YYYY-MM-DD)

Example:

"2025-01-01"

​
end_date
string<date>
required

End of the date range (YYYY-MM-DD)

Example:

"2025-03-01"

​
author
string
required

Git author login/email to analyze

Example:

"janedoe"

​
github_base_url
string
default:https://github.com

Base URL for GitHub (use for GitHub Enterprise Server)

Example:

"https://github.com"

​
gitlab_base_url
string
default:https://gitlab.com

Base URL for GitLab (use for self-hosted GitLab instances)

Example:

"https://gitlab.com"

​
azure_devops_base_url
string
default:https://dev.azure.com

Base URL for Azure DevOps (use for Azure DevOps Server)

Example:

"https://dev.azure.com"

​
bitbucket_base_url
string
default:https://api.bitbucket.org/2.0

Base URL for Bitbucket (use for Bitbucket Data Center/Server)

Example:

"https://api.bitbucket.org/2.0"

​
repositories
string[]

List of repository names to scope the summary. If omitted, all repositories under the organization are used.

Example:
["my-org/backend-api"]

Response

Developer summary

​
metric
string
Example:

"dev_summary"

​
platform
string
​
org
string
​
author
string
​
repositories
string[]
​
start_date
string<date>
​
end_date
string<date>
​
summary
string

AI-generated natural-language summary of the developer's work

​
pr_descriptions
string[]

Descriptions of PRs included in the analysis

​
execution_time
number

Time taken to generate the summary (seconds)