/ai/mailboxes/{id}/usage

GET

const url = 'https://example.com/api/v1/ai/mailboxes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/ai/mailboxes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

mailboxId

required

string

address

required

string

today

required

integer

>= -9007199254740991 <= 9007199254740991

last30Days

required

integer

>= -9007199254740991 <= 9007199254740991

limit

required

object

override

required

Any of:

integer
null

integer

<= 9007199254740991

effective

required

Any of:

integer
null

integer

<= 9007199254740991

source

required

string

Allowed values: mailbox domain server off

Example

{
  "limit": {
    "source": "mailbox"
  }
}