Usage a smtp credential

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/smtp-credentials/01JBT8XQ2M9WYC3K4F6R7S8T9V/usage' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/smtp-credentials/01JBT8XQ2M9WYC3K4F6R7S8T9V/usage', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/smtp-credentials/01JBT8XQ2M9WYC3K4F6R7S8T9V/usage",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/smtp-credentials/01JBT8XQ2M9WYC3K4F6R7S8T9V/usage');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/smtp-credentials/01JBT8XQ2M9WYC3K4F6R7S8T9V/usage")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringsmtp_credential_usage
  • windowobject

    The period these counts cover, stated in full so you do not have to infer the end from the start.

    • daysinteger

      Length of the window in days.

    • sincestring

      When the counting window starts, in ISO 8601 UTC. Null when counted is false.

    • untilstring

      ISO 8601 UTC. The moment the counts were computed against.

  • countedboolean

    Whether the counts below were measured. False when the key is not set up on the mail server yet; the counts are then null, not 0.

  • totalinteger

    Messages sent with this key. Null means unknown, not 0.

  • deliveredinteger

    Messages accepted by the receiving server. Null means unknown, not 0.

  • bouncedinteger

    Messages permanently refused. Null means unknown, not 0.

  • deferredinteger

    Messages temporarily refused and retried. Null means unknown, not 0.

  • rejectedinteger

    Messages we refused before sending. Null means unknown, not 0.

  • last_used_atstring

    When the key last signed in to send, in ISO 8601 UTC, read live from the mail server. Null means it has never been used.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.