Page through a domain's sent email

GET

/api/v1/email-sending/domains/{domain}/activity/page

curl --request GET \
  --url 'https://digize.com/api/v1/email-sending/domains/example/activity/page?period=30m' \
  --header 'x-api-key: <x-api-key>'

• Digize

A page of what a sending domain sent, one row per email and recipient, the newest first, over the last 30 minutes to 30 days (period, 30d unless it says). Narrow it by what became of each email (status), what sent it (via) or words in the subject, sender or recipient. Pass nextCursor back as cursor for the next page.

Needs the sites:read permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

domain

required

string

>= 3 characters <= 253 characters

Query Parameters

period

string

Allowed values: 30m 1h 6h 24h 7d 30d

status

Array<string>

Allowed values: sent delivered deferred bounced failed rejected complained

via

What sent them, as type:name: app:conversation, app:order-receipt, api:<the key’s name>, worker:<the worker’s name>, or app: and worker: for none.

Array<string>

<= 20 items

What sent them, as type:name: app:conversation, app:order-receipt, api:<the key’s name>, worker:<the worker’s name>, or app: and worker: for none.

search

string

<= 200 characters

cursor

The nextCursor of the page before. Leave it out for the first page.

string

<= 400 characters

The nextCursor of the page before. Leave it out for the first page.

limit

Rows on the page: 50 unless it says, 100 at most.

integer

>= 1 <= 100

Rows on the page: 50 unless it says, 100 at most.

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

string

messageId

required

string

domain

required

string

from

required

string

fromName

required

string

to

required

string

subject

required

string

via

required

One of:

object

object

type

required

string

Allowed value: app

name

required

string | null

object

object

type

required

string

Allowed value: api

key

required

string

object

object

type

required

string

Allowed value: worker

worker

required

string | null

status

required

string

Allowed values: sent delivered deferred bounced failed rejected complained

bounce

required

Any of:

string

string

Allowed values: hard soft spam

null

null

sentAt

required

string format: date-time

deliveredAt

required

Any of:

string

string format: date-time

null

null

attempts

required

Array<object>

object

at

required

string format: date-time

server

required

string

response

required

string

rejection

required

string | null

size

required

number

attachments

required

number

previewable

required

boolean

conversationId

required

string | null

nextCursor

required

Pass it as cursor for the next page; null on the last.

string | null

Example

{
  "rows": [
    {
      "via": {
        "type": "app"
      },
      "status": "sent",
      "bounce": "hard"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}