Get number pool statistics

GET

/api/v1/number-pools/{number_pool_id}/statistics

curl --request GET \
  --url https://external-api.moja-ai.com/api/v1/number-pools/example/statistics \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

number_pool_id

required

Number Pool Id

string

Responses

200

Successful Response

Media typeapplication/json

NumberPoolStatisticsEnvelopeResponse

object

number_pool_id

required

Number Pool Id

Unique identifier for the number pool

string

statistics

required

NumberPoolStatisticsResponse

Statistics for the number pool

object

total_numbers

required

Total Numbers

Total number of numbers in the number pool

integer

allocated_numbers

required

Allocated Numbers

Number of allocated numbers in the number pool

integer

available_numbers

required

Available Numbers

Number of available numbers in the number pool

integer

impressions_per_day

required

Impressions Per Day

Number of impressions per day

integer

misses_per_day

required

Misses Per Day

Number of misses per day

integer

impressions_per_month

required

Impressions Per Month

Number of impressions per month

integer

misses_per_month

required

Misses Per Month

Number of misses per month

integer

utilization_rate

required

Utilization Rate

Utilization rate of the number pool

number

Example^generated

{
  "number_pool_id": "example",
  "statistics": {
    "total_numbers": 1,
    "allocated_numbers": 1,
    "available_numbers": 1,
    "impressions_per_day": 1,
    "misses_per_day": 1,
    "impressions_per_month": 1,
    "misses_per_month": 1,
    "utilization_rate": 1
  }
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

500

Internal server error