List deliveries to a channel

gethttps://api.mentio.dev/v1/channels/{id}/deliveries

Authentication

AuthorizationBearer <token>Required

An API key (mk_live_...) from the dashboard or an OAuth access token. See Authentication.

Path parameters

idstringRequired

Channel id (dest_...).

1 to ∞ characters

Query parameters

cursorstringOptional

Opaque cursor from a previous page (nextCursor).

limitintegerOptional

How many deliveries, newest first, 1 to 200 (default 50).

Default501 to 200

Response

200What the channel received, newest first: instant mentions and digest runs, with status and last error

dataarray<object>Required

Deliveries, newest first.

+Show 10 properties

idstringRequired

Delivery id (dlv_...), also the webhook payload id.

kindstringRequired

mention: an instant rule's delivery. digest: a daily or weekly summary. event: an account event the channel subscribed to.

One ofmentiondigestevent

eventstringRequired

The event name the payload carried: the rule's (mention.matched unless it set one, digest for a summary) or the account event's.

statusstringRequired

pending, delivered or failed.

One ofpendingdeliveredfailed

attemptsintegerRequired

Send attempts so far.

errorstringnullableRequired

The last failure, when there was one.

sentAtstringnullableRequired

ISO 8601 timestamp, UTC.

createdAtstringRequired

ISO 8601 timestamp, UTC.

alertobjectRequired

The alert that produced it; name only, since alerts can be deleted. name is null for an account event, which no rule produces.

+Show 1 property

namestringnullableRequired

Alert name.

mentionobjectnullableRequired

For mention deliveries: the post, text cut to 160 characters.

+Show 3 properties

idstringRequired

Mention id.

urlstringRequired

Link to the post.

textstringRequired

The post text, cut to 160 characters.

nextCursorstringnullableRequired

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

400Invalid request: a parameter or the body failed validation (validation_error)

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

unauthorizedforbiddenread_only_keyvalidation_errornot_foundinvalid_cursorpayload_too_largeidempotency_key_in_useidempotency_key_reusedrate_limitedduplicate_keywordinsufficient_balancekeyword_limit_reachedbilling_not_configuredorder_not_creditedschedule_requiredunknown_channelnot_a_digesthourly_email_unsupportedslack_not_connectedslack_not_configuredtelegram_not_configuredfeed_unreadablefeed_login_requiredfeed_login_expiredfeed_limit_reachedfeed_auth_not_configuredemail_not_configuredinvalid_assigneeclassification_pendinginvalid_memberalready_memberlast_ownerduplicate_segmentfilter_too_complexduplicate_viewduplicate_groupdefault_groupdefault_group_contextgroup_changedinvalid_signaturewebhook_not_configuredinvalid_tokenprotected_userupstream_unavailableinternal_error

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

401Missing or invalid API key

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

404Channel not found

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

https://api.mentio.dev/v1/channels/{id}/deliveries

const response = await fetch('https://api.mentio.dev/v1/channels/{id}/deliveries', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MENTIO_API_KEY}`,
  },
});

const data = await response.json();
console.log(data);

Response

{
  "data": [
    {
      "id": "string",
      "kind": "mention",
      "event": "string",
      "status": "pending",
      "attempts": 0,
      "error": "string",
      "sentAt": "string",
      "createdAt": "string",
      "alert": {
        "name": "string"
      },
      "mention": {
        "id": "string",
        "url": "https://example.com",
        "text": "string"
      }
    }
  ],
  "nextCursor": "string"
}

View as Markdown Ask ChatGPT about this page Ask Claude about this page OpenAPI specification Get an API key