TLtlmtr
Catalog

Catalog Search

Changed on

Search channels in catalog with advanced filters and sorting.

get/v1/catalog/search

Request

Query parameters

termstring

Search phrase in channel name.

Minimum 3 characters (1 for Chinese)

search_in_aboutboolean

Search in channel description.

term will be searched not only in the channel name but also in the description

countrystring

Channel country.

List of countries can be obtained here /v1/dictionaries/countries

languagestring

Channel language.

List of languages can be obtained here /v1/dictionaries/languages

categorystring

Channel category id.

List of categories can be obtained here /v1/dictionaries/categories Example: mf2MkrwoE

members_mininteger

Minimum members count

members_maxinteger

Maximum members count

views_mininteger

Minimum average post views

views_maxinteger

Maximum average post views

er_mininteger

Minimum engagement rate

er_maxinteger

Maximum engagement rate

privacy'Public' | 'Private'

Channel privacy type

Example:Public

Channel privacy

verified_onlyboolean

Only Telegram verified channels

sort_by'members_count' | 'members_growth7d' | 'members_growth30d' | 'members_growth90d' | 'post_views' | 'post_views24h' | 'er' | 'ads_index' | 'mentions_all' | 'mentions7_d' | 'mentions30_d'

Catalog sort field

Sort field

sort_direction'asc' | 'desc'

Sort direction

limitinteger

Number of results.

Default is 20. Maximum is 100.

skipinteger

Skip results

Response

Catalog search results

countinteger required

Total count of results

audience_countinteger required

Total audience count

Example response

{
  "items": [
    {
      "internal_id": "1B3CMw",
      "title": "News Channel",
      "members_count": 50000,
      "privacy": "Public",
      "photo_url": "https://img.telemetr.io/c/1l1EcE/5406980229706134223?w=64&h=64",
      "country": "ukraine",
      "language": "ua",
      "category": "mf2MkrwoE",
      "post_views": 25000,
      "post_views_24h": 20000,
      "er": 5.2,
      "ads_index": "A+",
      "mentions": {
        "all_time": 1234,
        "last_7_days": 45,
        "last_30_days": 150
      }
    }
  ],
  "count": 1523,
  "audience_count": 15234567
}

Changes

  • 6c2bfd66c5f2Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added subschema #2 to the response body allOf list for the response status

  • 80951ad7b3fbRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status