⚠️ This documentation pertains to a preview endpoint. This feature is not yet ready for API consumption and may change.
For inquiries or feedback, please contact us at Glean.

Read messages

post/messages

Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams).

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

Includes request params such as the id for channel/message and direction.

id
required
string

ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID.

idType
required
string

Type of the id in the incoming request.

Enum: "CHANNEL_NAME" "THREAD_ID" "CONVERSATION_ID"
timestampMillis
required
integer <int64>

Timestamp in millis of the reference message.

datasource
string

The type of the data source. Missing field defaults to SLACK.

Enum: "SLACK" "MICROSOFTTEAMS" "FACEBOOKWORKPLACE"
datasourceInstanceDisplayName
string

The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances.

direction
string

The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER.

Enum: "OLDER" "NEWER"
includeRootMessage
boolean

Whether to include root message in response.

workspaceId
string

Id for the for the workspace in case of multiple workspaces.

Responses
200

OK

Response Schema: application/json
hasMore
required
boolean

Whether there are more results for client to continue requesting.

object (SearchResult)
object (SearchResponse)
400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "idType": "CHANNEL_NAME",
  • "id": "string",
  • "workspaceId": "string",
  • "direction": "OLDER",
  • "timestampMillis": 0,
  • "includeRootMessage": true,
  • "datasource": "SLACK",
  • "datasourceInstanceDisplayName": "string"
}
Response samples
application/json
{
  • "hasMore": true,
  • "searchResponse": {
    • "trackingToken": "trackingToken",
    • "suggestedSpellCorrectedQuery": "suggestedSpellCorrectedQuery",
    • "hasMoreResults": true,
    • "errorInfo": {
      • "errorMessages": [
        • {
          • "source": "gmail",
          • "errorMessage": "invalid token"
          },
        • {
          • "source": "slack",
          • "errorMessage": "expired token"
          }
        ]
      },
    • "requestID": "5e345ae500ff0befa2b9d1a3ba0001737e7363696f312d323535323137000171756572792d656e64706f696e743a323032303031333074313830343032000100",
    • "results": [
      • {
        • "snippets": [
          • {
            • "snippet": "snippet",
            • "mimeType": "mimeType"
            }
          ],
        • "metadata": {
          • "container": "container",
          • "createTime": "2000-01-23T04:56:07.000Z",
          • "datasource": "datasource",
          • "author": {
            • "name": "name"
            },
          • "documentId": "documentId",
          • "updateTime": "2000-01-23T04:56:07.000Z",
          • "mimeType": "mimeType",
          • "objectType": "objectType"
          },
        • "title": "title",
        • "url": "https://www.example.com/"
        },
      • {
        • "snippets": [
          • {
            • "snippet": "snippet",
            • "mimeType": "mimeType"
            }
          ],
        • "metadata": {
          • "container": "container",
          • "createTime": "2000-01-23T04:56:07.000Z",
          • "datasource": "datasource",
          • "author": {
            • "name": "name"
            },
          • "documentId": "documentId",
          • "updateTime": "2000-01-23T04:56:07.000Z",
          • "mimeType": "mimeType",
          • "objectType": "objectType"
          },
        • "title": "title",
        • "url": "https://www.example.com/"
        }
      ],
    • "facetResults": [
      • {
        • "buckets": [
          • {
            • "percentage": 5,
            • "count": 1,
            • "value": {
              • "stringValue": "stringValue",
              • "integerValue": 5
              }
            },
          • {
            • "percentage": 5,
            • "count": 1,
            • "value": {
              • "stringValue": "stringValue",
              • "integerValue": 5
              }
            }
          ],
        • "sourceName": "sourceName",
        • "operatorName": "operatorName",
        • "objectType": "objectType"
        },
      • {
        • "buckets": [
          • {
            • "percentage": 5,
            • "count": 1,
            • "value": {
              • "stringValue": "stringValue",
              • "integerValue": 5
              }
            },
          • {
            • "percentage": 5,
            • "count": 1,
            • "value": {
              • "stringValue": "stringValue",
              • "integerValue": 5
              }
            }
          ],
        • "sourceName": "sourceName",
        • "operatorName": "operatorName",
        • "objectType": "objectType"
        }
      ],
    • "rewrittenQuery": "rewrittenQuery",
    • "rewrittenFacetFilters": [
      • {
        • "fieldName": "fieldName",
        • "values": [
          • "fieldValues",
          • "fieldValues"
          ]
        },
      • {
        • "fieldName": "fieldName",
        • "values": [
          • "fieldValues",
          • "fieldValues"
          ]
        }
      ]
    },
  • "rootMessage": {
    • "snippets": [
      • {
        • "snippet": "snippet",
        • "mimeType": "mimeType"
        }
      ],
    • "metadata": {
      • "container": "container",
      • "createTime": "2000-01-23T04:56:07.000Z",
      • "datasource": "datasource",
      • "author": {
        • "name": "name"
        },
      • "documentId": "documentId",
      • "updateTime": "2000-01-23T04:56:07.000Z",
      • "mimeType": "mimeType",
      • "objectType": "objectType"
      },
    • "title": "title",
    • "url": "https://example.com/foo/bar",
    • "nativeAppUrl": "slack://foo/bar",
    • "mustIncludeSuggestions": [
      • {
        • "missingTerm": "container",
        • "query": "container"
        }
      ]
    }
}