Messages

List delivery logs

Changed on

Returns a paginated list of delivery logs for the specified message.

get/v1/messages/{message_id}/delivery_logs

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/messages/{message_id}/delivery_logs
  • Auth: HTTP bearer

Path parameters

message_idstring required

The ID of the message to fetch delivery logs for.

Query parameters

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

Response

OK

Example response

{
  "items": [
    {
      "__typename": "MessageDeliveryLog",
      "environment_id": "123e4567-e89b-12d3-a456-426614174000",
      "id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe",
      "inserted_at": "2021-01-01T00:00:00Z",
      "request": {
        "body": {
          "html_content": "<html></html>"
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "host": "localhost",
        "method": "GET",
        "path": "/",
        "query": "?foo=bar"
      },
      "response": {
        "body": {
          "success": true
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "status": 200
      },
      "service_name": "Postmark"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes

  • 46f457b0a700Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status

  • 5176d1bb3a88Revision changes
    • breaking

      added subschema #1 subschema #2 to the /// response property oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status