Get organization stats

GET

/v1/organizations/:organizationId/stats/

Get organization stats

Required Permission: base.organization.stats.get

Get organization stats

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

statTypes array

optional

dateIni string

optional

Format: date-time

dateEnd string

optional

Format: date-time

Responses

200 Response application/json

status boolean optional

data object optional

filter object optional

organization string optional

Match pattern: ^[a-fA-F0-9]{24}$

search object optional

statTypes array [string] optional

dateIni string optional

Format: date-time

dateEnd string optional

Format: date-time

times object optional

data object optional

{
    "status": true,
    "data": {
        "filter": {
            "organization": "string",
            "search": {
                "statTypes": [
                    "builds-by-os"
                ],
                "dateIni": "2024-01-01T00: 00:00Z",
                "dateEnd": "2024-01-01T00: 00:00Z"
            }
        },
        "times": {},
        "data": {}
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}