RESTful API Help

Get Top Contributors

Get top contributors on default branch

Http Method

GET

End Point

/~api/projects/{projectId}/top-contributors

Placeholder	Description	Example
{projectId}	Project Id	1

Query Parameters

Parameter	Description	Required	Example
type	Type	Yes	COMMITS
sinceDate	Since date of format yyyy-MM-dd	Yes	string
untilDate	Until date of format yyyy-MM-dd	Yes	string
count	Count	Yes	1

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: [ {

"author" : {

"name" : "string" ,
"emailAddress" : "string" ,
"when" : 1 ,
"tzOffset" : 1

} ,
"totalContribution" : {

"commits" : 1 ,
"additions" : 1 ,
"deletions" : 1

} ,
"dailyContributions" : {

"2021-01-01" : 1

}

} ]

Operation Failed

Status code: Status code other than 200 indicating the error type
Response Body: Error detail of content type "text/plain"

cURL Example

$ curl -u <login name>:<password or access token> -G https://crash.software/~api/projects/1/top-contributors --data-urlencode type=COMMITS --data-urlencode sinceDate=string --data-urlencode untilDate=string --data-urlencode count=1