Search for messages matching a given indexation key.

GET 
/api/v1/messages

Search for messages matching a given indexation key.

Request

Query Parameters

index stringrequired
Hex-encoded indexation key that should be searched for.
Example: 68656c6c6f20776f726c64

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

index stringrequired

The provided hex-encoded indexation key that was used to search for.

maxResults integerrequired

The number of results it can return at most.

count integerrequired

The actual number of found results.

messageIds string[]required

The identifiers of the found messages that match the given indexation key.

Example (from schema)

{
  "data": {
    "index": "string",
    "maxResults": 0,
    "count": 0,
    "messageIds": [
      "string"
    ]
  }
}

default

{
  "data": {
    "index": "68656c6c6f20776f726c64",
    "maxResults": 1000,
    "count": 2,
    "messageIds": [
      "f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
      "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006"
    ]
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...