API docs by Redocly

Key Elements Prophecy API (1.0.0)

Download OpenAPI specification:Download

search

Search across data lake

Search across all datasets

Primary search endpoint for dashboard

Request Body schema: application/json
required

Query

query
required
string non-empty
size
integer <int64> [ 1 .. 50 ]
Default: 20
page
integer <int64> >= 1
Default: 1
group
string (PostSearchGroupBy)
Enum: "actor" "content" "source"
Array of objects or null (PostSearchFilter) unique
Array of objects non-empty unique
highlight
boolean

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "size": 20,
  • "page": 1,
  • "group": "actor",
  • "filters": [
    ],
  • "sort": [
    ],
  • "highlight": true
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "pages": 0,
  • "took": 0,
  • "results": [
    ]
}

Filters for narrowing down search

Aggregations on field values for narrowing down search results for a given query

Request Body schema: application/json
required

Query

query
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "filters": [
    ]
}

telegram

Telegram data

Get Telegram Channel

Get Telegram Channel by ID

path Parameters
channelId
required
string

ID of Telegram Channel

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "PEER_UNKNOWN",
  • "name": "string",
  • "username": "string",
  • "topic": "string",
  • "megagroup": true,
  • "gigagroup": true,
  • "verified": true,
  • "scam": true,
  • "fake": true,
  • "support": true,
  • "restricted": true,
  • "signatures": true,
  • "noForwards": true,
  • "slowMode": true,
  • "joinRequest": true,
  • "joinToSend": true,
  • "inviteLink": "string",
  • "members": {
    },
  • "messages": 0,
  • "permissions": {
    },
  • "restrictions": [
    ],
  • "bots": [
    ],
  • "linkedChat": "string",
  • "migratedFrom": "string",
  • "migratedTo": "string",
  • "pinnedMessage": "string",
  • "ttl": 0,
  • "photo": {
    },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Get Telegram Channel Message Analytics

Time series data for total messages sent in the channel

path Parameters
channelId
required
string

ID of Telegram Channel

query Parameters
interval
required
string (TimeSeriesIntervalEnum)
Enum: "minute" "hour" "day" "week" "month" "quarter" "year"

Calendar intervals

start
required
string non-empty

Start date

end
required
string non-empty

End date

timezone
required
string non-empty

IANA timezone

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Telegram Channel Members Analytics

Time series data for total members in the channel

path Parameters
channelId
required
string

ID of Telegram Channel

query Parameters
interval
required
string (TimeSeriesIntervalEnum)
Enum: "minute" "hour" "day" "week" "month" "quarter" "year"

Calendar intervals

start
required
string non-empty

Start date

end
required
string non-empty

End date

timezone
required
string non-empty

IANA timezone

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Telegram Channel Heatmap Analytics

Time series data for average total messages per hour across a preset fixed interval

path Parameters
channelId
required
string

ID of Telegram Channel

query Parameters
fixedInterval
required
string (TimeSeriesFixedIntervalEnum)
Enum: "week" "month" "quarter" "year"

Fixed interval

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Telegram Channel Members

Get Telegram Channel Members by ID

path Parameters
channelId
required
string

ID of Telegram Channel

query Parameters
size
integer <int64> (PaginationSize) [ 1 .. 50 ]
Default: 10

Pagination Size

page
integer <int64> (PaginationPage) >= 1
Default: 1

Pagination Current Page

sortBy
string (TelegramMembersSortEnum)
Enum: "joined" "messages" "files"

Sort by

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "pages": 0,
  • "members": [
    ]
}

Get Telegram Channel Files

Get Telegram Channel Files by ID

path Parameters
channelId
required
string

ID of Telegram Channel

Request Body schema: application/json
required

Query

size
integer <int64> (PaginationSize) [ 1 .. 50 ]
Default: 10
page
integer <int64> (PaginationPage) >= 1
Default: 1
sortBy
string (TelegramFilesSortBy)
Enum: "name" "size" "files"
types
Array of strings (TelegramFilesTypes)
Items Enum: "PHOTO" "VIDEO" "EMOJI" "VOICE" "DOCUMENT" "STICKER" "ANIMATION" "VIDEO_NOTE" "AUDIO" "WEB_PAGE"

Responses

Request samples

Content type
application/json
{
  • "size": 10,
  • "page": 1,
  • "sortBy": "name",
  • "types": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "pages": 0,
  • "files": [
    ]
}

Get Telegram User

Get Telegram User by ID

path Parameters
userId
required
string

ID of Telegram User

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "PEER_UNKNOWN",
  • "name": "string",
  • "username": "string",
  • "topic": "string",
  • "megagroup": true,
  • "gigagroup": true,
  • "verified": true,
  • "scam": true,
  • "fake": true,
  • "support": true,
  • "restricted": true,
  • "signatures": true,
  • "noForwards": true,
  • "slowMode": true,
  • "joinRequest": true,
  • "joinToSend": true,
  • "inviteLink": "string",
  • "members": {
    },
  • "messages": 0,
  • "permissions": {
    },
  • "restrictions": [
    ],
  • "bots": [
    ],
  • "linkedChat": "string",
  • "migratedFrom": "string",
  • "migratedTo": "string",
  • "pinnedMessage": "string",
  • "ttl": 0,
  • "photo": {
    },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Get Telegram Message

Get Telegram Message by ID

path Parameters
messageId
required
string

ID of Telegram Message

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tid": "string",
  • "author": {
    },
  • "channel": {
    },
  • "forwardedFrom": {
    },
  • "repliedTo": {
    },
  • "mediaType": "MESSAGE_MEDIA_TYPE_UNKNOWN",
  • "contents": [
    ],
  • "media": {
    },
  • "location": {
    },
  • "contact": {
    },
  • "venue": {
    },
  • "webPage": {
    },
  • "poll": {
    },
  • "dice": {
    },
  • "commands": [
    ],
  • "pinned": true,
  • "noForwards": true,
  • "spoiler": true,
  • "scheduled": true,
  • "views": 0,
  • "forwards": 0,
  • "groupedId": "string",
  • "reactions": [
    ],
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get Telegram Message stream

Get surrounding Telegram messages

path Parameters
messageId
required
string

ID of Telegram Message

query Parameters
next
required
boolean
Default: true

Fetch messages after the given message

previous
required
boolean
Default: true

Fetch messages before the given message

size
required
integer <int64> [ 1 .. 50 ]
Default: 10

Calendar intervals

Responses

Response samples

Content type
application/json
{
  • "total": {
    },
  • "messages": [
    ]
}

Get Telegram File

Get Telegram File by ID

path Parameters
fileId
required
string

ID of Telegram File

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tid": "string",
  • "hash": "string",
  • "type": "string",
  • "mimeType": "string",
  • "name": "string",
  • "width": 0,
  • "height": 0,
  • "size": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "storage": "string",
  • "duplicates": 0,
  • "message": {
    }
}