Analytics

Analytics Overview Historical Report

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

typestring · enumRequiredPossible values:

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

calc_typeany ofOptionalDefault: request_number

string · enumOptionalPossible values:

or

nullOptional

timezoneany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/historical

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/historical HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "type": "hit",
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "calc_type": "request_number",
  "timezone": "text"
}

No content

Analytics Overview Top Resources

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

limitany ofOptional

integerOptional

or

nullOptional

pageany ofOptionalDefault: 1

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/top_resources

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/top_resources HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "limit": 1,
  "page": 1
}

No content

Analytics Overview Errors

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

limitany ofOptional

integerOptional

or

nullOptional

pageany ofOptionalDefault: 1

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/errors

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/errors HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "limit": 1,
  "page": 1
}

No content

Analytics Overview Visitors Countries

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

limitany ofOptional

integerOptional

or

nullOptional

pageany ofOptionalDefault: 1

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/visitors_countries

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/visitors_countries HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "limit": 1,
  "page": 1
}

No content

Analytics Overview Active Hit Traffic

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typeanyRequired

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

intervalany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/active_{type}

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/active_{type} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

No content

Analytics Cache Histogram Traffic

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cache_typeanyRequired

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

intervalany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/{cache_type}_traffic_report/graph

HTTPcURLJavaScriptPython

POST /api/v1/{cache_type}_traffic_report/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

No content

Analytics Histogram

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typeundefined · enumRequiredPossible values:

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

intervalany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/{type}_report/graph

HTTPcURLJavaScriptPython

POST /api/v1/{type}_report/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

No content

Analytics Histogram Status 2XX

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

status_codeanyRequired

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

intervalany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/status_report/graph/{status_code}

HTTPcURLJavaScriptPython

POST /api/v1/status_report/graph/{status_code} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

No content

Analytics Overview Historical Report

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/traffic_report/detail

HTTPcURLJavaScriptPython

POST /api/v1/traffic_report/detail HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text"
}

No content

Analytics Overview Historical Report

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/requests_report/detail

HTTPcURLJavaScriptPython

POST /api/v1/requests_report/detail HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text"
}

No content

Analytics Error List

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptionalDefault: 1

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

page_sizeany ofOptional

integerOptional

or

nullOptional

statusCodesinteger[]Optional

List of status codes

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/error_logs/status_codes

HTTPcURLJavaScriptPython

POST /api/v1/error_logs/status_codes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "page_size": 1,
  "statusCodes": [
    1
  ]
}

No content

Analytics Status Code

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/error_report/status_codes

HTTPcURLJavaScriptPython

POST /api/v1/error_report/status_codes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text"
}

No content

Analytics.Overview.Region

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/region

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/region HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text"
}

No content

Analytics.Overview.Region Billing

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/region_billing

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/region_billing HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text"
}

No content

Gpu Stat Details

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

agg_typestring · enumOptionalDefault: formatPossible values:

io_process_filterany ofOptionalDefault: all

stringOptional

or

string[]Optional

or

nullOptional

format_filterany ofOptionalDefault: all

stringOptional

or

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/gpu_stat_details

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/gpu_stat_details HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "agg_type": "format",
  "io_process_filter": "all",
  "format_filter": "all"
}

No content

Gpu Histogram Details

post

Authorizations

JWTBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

organization_uuidstringRequired

resourcesany ofOptional

string[]Optional

or

nullOptional

fromstring · date-timeRequiredExample: 2024-11-12 00:00:00

tostring · date-timeRequiredExample: 2024-11-12 23:59:59

timezoneany ofOptional

stringOptional

or

nullOptional

intervalany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v1/overview_report/gpu_histogram_details

HTTPcURLJavaScriptPython

POST /api/v1/overview_report/gpu_histogram_details HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

No content

Analytics.Histogram.Traffic

post

Authorizations

JWTBearer

Body

application/json

organization_uuidstringRequired

The unique identifier of the organization.

resourcesany ofOptional

It is used to see the data of a specific resource or all resources in the organization. Returns the total of the selected resources. If no resource is selected, it returns the total of all resources.

string[]Optional

or

nullOptional

fromstring · date-timeRequired

It is considered the starting point in a specific date range.

Example: 2024-11-12 00:00:00

tostring · date-timeRequired

It is considered the last point in a given date range.

Example: 2024-11-12 23:59:59

timezoneany ofOptional

Timezone for grouping (e.g., Europe/Istanbul). Defaults to user’s timezone.

stringOptional

or

nullOptional

intervalany ofOptional

Indicates the time range of the data to be retrieved.

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/v1/traffic_report/graph

HTTPcURLJavaScriptPython

POST /api/v1/traffic_report/graph HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

{
  "status": true,
  "data": {
    "progressive": [
      {
        "time": 1,
        "traffic": 1,
        "traffic_formatted": "text"
      }
    ],
    "stream": [
      {
        "time": 1,
        "traffic": 1,
        "traffic_formatted": "text"
      }
    ]
  }
}

Analytics.Histogram.Bandwidth

post

Authorizations

JWTBearer

Body

application/json

organization_uuidstringRequired

The unique identifier of the organization.

resourcesany ofOptional

It is used to see the data of a specific resource or all resources in the organization. Returns the total of the selected resources. If no resource is selected, it returns the total of all resources.

string[]Optional

or

nullOptional

fromstring · date-timeRequired

It is considered the starting point in a specific date range.

Example: 2024-11-12 00:00:00

tostring · date-timeRequired

It is considered the last point in a given date range.

Example: 2024-11-12 23:59:59

timezoneany ofOptional

Timezone for grouping (e.g., Europe/Istanbul). Defaults to user’s timezone.

stringOptional

or

nullOptional

intervalany ofOptional

Indicates the time range of the data to be retrieved.

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/v1/bandwidth_report/graph

HTTPcURLJavaScriptPython

POST /api/v1/bandwidth_report/graph HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "organization_uuid": "text",
  "resources": [
    "text"
  ],
  "from": "2024-11-12 00:00:00",
  "to": "2024-11-12 23:59:59",
  "timezone": "text",
  "interval": "text"
}

{
  "status": true,
  "data": {
    "progressive": [
      {
        "time": 1,
        "bandwidth": "text",
        "bandwidth_formatted": "text"
      }
    ],
    "streaming": [
      {
        "time": 1,
        "bandwidth": "text",
        "bandwidth_formatted": "text"
      }
    ]
  }
}