For the complete documentation index, see llms.txt. This page is also available as Markdown.

Consultar el uso de evaluaciones

Get screening usage

get

Get the account's screening usage count based on screen tasks. Optionally filter by a time range and a target type. If both startTime and endTime are omitted, the current billing cycle is used by default.

Autorizaciones
API-KeystringRequerido
Parámetros de consulta
startTimeinteger · int64Opcional

Start of the time range, as a Unix timestamp in seconds (inclusive). If both startTime and endTime are omitted, the current billing cycle is used.

Example: 1704067200
endTimeinteger · int64Opcional

End of the time range, as a Unix timestamp in seconds (inclusive). If both startTime and endTime are omitted, the current billing cycle is used.

Example: 1706745600
targetstring · enumOpcional

The target type to count. Omit to count all targets.

Example: addressValores posibles:
Respuestas
200

Response. A non-zero code indicates a business error even when the HTTP status is 200.

application/json
codeintegerOpcional

The business status code. 0 means the request succeeded; any other value means it failed. Business errors are returned with HTTP 200 and a non-zero code, so a 200 response is not by itself a success — always check this field. Authentication and rate-limiting failures use a non-200 HTTP status instead, so check both.

Example: 0
msgstringOpcional

"Success" when code is 0, otherwise the error message for that code.

Example: Success
get/account/usage/screening
GET /phalcon/compliance/v2/account/usage/screening HTTP/1.1
Host: api.blocksec.com
API-Key: YOUR_API_KEY
Accept: */*
{
  "code": 0,
  "msg": "Success",
  "data": {
    "screeningCount": 1234
  }
}

Última actualización