Message counts over time

GET

/domains/{domain}/email-routing/summary

const url = 'https://api.nsin.ir/domains/example.com/email-routing/summary?range=30m';
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://api.nsin.ir/domains/example.com/email-routing/summary?range=30m' \
  --header 'Authorization: Bearer <token>'

Received / forwarded / dropped / rejected / deferred, as totals and as a bucketed series. received is every message except discarded bounces. Requires domain.view.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

The domain name (for example example.com) — not a numeric id.

Example

example.com

Query Parameters

range

string

default: 24h

Allowed values: 30m 24h 7d 30d custom

Time window, ending now. 30m buckets by minute, 24h by hour, 7d and 30d by day. custom takes RFC 3339 from and to (at most 31 days apart) and picks the bucket from the span.

from

string format: date-time

Start of a custom range, RFC 3339.

string format: date-time

End of a custom range, RFC 3339.

Responses

200

Totals and series.

application/json

object

range

string

from

string format: date-time

bucket

string

Allowed values: minute hour day

totals

object

received

Every message except discarded bounces.

integer

forwarded

integer

dropped

integer

rejected

integer

deferred

integer

series

Array

object

string format: date-time

received

Every message except discarded bounces.

integer

forwarded

integer

dropped

integer

rejected

integer

deferred

integer

Example

{
  "bucket": "minute"
}

400

Bad range or custom bounds.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

404

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}

503

The activity log store is temporarily unreachable. Retry; no data is lost.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

unavailable

{
  "error": "activity log temporarily unavailable"
}