Skip to content
Anvil Docs
  • Auto
  • Light
  • Dark
Get Started

Get Topics

API Reference
Client
Get metrics for all the topics by website ID
get_topics(ClientGetTopicsParams**kwargs) -> archivedboolaverage_rankingGetTopicsResponseItemAverageRankingmention_rateGetTopicsResponseItemMentionRateprompts_countintroifloatsearch_volumeintshare_of_voiceGetTopicsResponseItemShareOfVoicestartedbooltopicGetTopicsResponseItemTopicGetTopicsResponse
post/api/beta/topics

Returns metrics for all the topics by website ID

Parameters
from_dateint
formatint64
llm_providerstr
tag_idslist
List[str]
to_dateint
formatint64
archivebool
optional
competitor_urlstr
optional
Returns
GetTopicsResponsetype
List[GetTopicsResponseItem]
Hide ParametersShow Parameters
archivedbool
optional
average_rankingaveragefloatdata_formatliteraldateslistdays_spanintdeltafloatdisplay_namestrfrom_datedatetimelanguageliterallocaleliteralmedianfloatmetric_namestrserieslistto_datedatetimevaluefloatGetTopicsResponseItemAverageRanking
optional
Hide ParametersShow Parameters
averagefloat
optional
formatdouble
data_formatliteral
optional
Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]
Hide ParametersShow Parameters
"NUMBER"
"PERCENTAGE"
"CURRENCY"
"TEXT"
"SCORE"
dateslist
optional
Optional[List[datetime]]
days_spanint
optional
formatint32
deltafloat
optional
formatdouble
display_namestr
optional
from_datedatetime
optional
formatdate-time
languageliteral
optional
Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
localeliteral
optional
Optional[Literal["GLOBAL", "ISRAEL", "EU", 97 more]]
Hide ParametersShow Parameters
"GLOBAL"
"ISRAEL"
"EU"
"UK"
"US"
"IL"
"AL"
"AZ"
"KG"
"BA"
"UZ"
"BI"
"XK"
"SM"
"DE"
"AT"
"CH"
"IE"
"IM"
"FR"
"ES"
"NL"
"IT"
"PT"
"BE"
"AD"
"MT"
"MC"
"MA"
"LU"
"TN"
"DZ"
"GI"
"LI"
"SE"
"DK"
"FI"
"NO"
"AX"
"IS"
"GG"
"JE"
"GL"
"VA"
"FX"
"FO"
"AF"
"AM"
"AU"
"BH"
"BD"
"BT"
"BN"
"KH"
"CN"
"CY"
"GE"
"HK"
"IN"
"ID"
"IR"
"IQ"
"JP"
"JO"
"KZ"
"KW"
"LA"
"LB"
"MY"
"MV"
"MN"
"MM"
"NP"
"OM"
"PK"
"PH"
"QA"
"SA"
"SG"
"KR"
"LK"
"SY"
"TW"
"TH"
"TR"
"AE"
"VN"
"YE"
"AR"
"BO"
"BR"
"CL"
"CO"
"EC"
"GY"
"PY"
"PE"
"SR"
"UY"
"VE"
medianfloat
optional
formatdouble
metric_namestr
optional
serieslist
optional
Optional[List[GetTopicsResponseItemAverageRankingSery]]
Hide ParametersShow Parameters
datedatetime
formatdate-time
valuefloat
formatdouble
to_datedatetime
optional
formatdate-time
valuefloat
optional
formatdouble
mention_rateaveragefloatdata_formatliteraldateslistdays_spanintdeltafloatdisplay_namestrfrom_datedatetimelanguageliterallocaleliteralmedianfloatmetric_namestrserieslistto_datedatetimevaluefloatGetTopicsResponseItemMentionRate
optional
Hide ParametersShow Parameters
averagefloat
optional
formatdouble
data_formatliteral
optional
Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]
Hide ParametersShow Parameters
"NUMBER"
"PERCENTAGE"
"CURRENCY"
"TEXT"
"SCORE"
dateslist
optional
Optional[List[datetime]]
days_spanint
optional
formatint32
deltafloat
optional
formatdouble
display_namestr
optional
from_datedatetime
optional
formatdate-time
languageliteral
optional
Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
localeliteral
optional
Optional[Literal["GLOBAL", "ISRAEL", "EU", 97 more]]
Hide ParametersShow Parameters
"GLOBAL"
"ISRAEL"
"EU"
"UK"
"US"
"IL"
"AL"
"AZ"
"KG"
"BA"
"UZ"
"BI"
"XK"
"SM"
"DE"
"AT"
"CH"
"IE"
"IM"
"FR"
"ES"
"NL"
"IT"
"PT"
"BE"
"AD"
"MT"
"MC"
"MA"
"LU"
"TN"
"DZ"
"GI"
"LI"
"SE"
"DK"
"FI"
"NO"
"AX"
"IS"
"GG"
"JE"
"GL"
"VA"
"FX"
"FO"
"AF"
"AM"
"AU"
"BH"
"BD"
"BT"
"BN"
"KH"
"CN"
"CY"
"GE"
"HK"
"IN"
"ID"
"IR"
"IQ"
"JP"
"JO"
"KZ"
"KW"
"LA"
"LB"
"MY"
"MV"
"MN"
"MM"
"NP"
"OM"
"PK"
"PH"
"QA"
"SA"
"SG"
"KR"
"LK"
"SY"
"TW"
"TH"
"TR"
"AE"
"VN"
"YE"
"AR"
"BO"
"BR"
"CL"
"CO"
"EC"
"GY"
"PY"
"PE"
"SR"
"UY"
"VE"
medianfloat
optional
formatdouble
metric_namestr
optional
serieslist
optional
Optional[List[GetTopicsResponseItemMentionRateSery]]
Hide ParametersShow Parameters
datedatetime
formatdate-time
valuefloat
formatdouble
to_datedatetime
optional
formatdate-time
valuefloat
optional
formatdouble
prompts_countint
optional
formatint32
roifloat
optional
formatdouble
search_volumeint
optional
formatint32
share_of_voiceaveragefloatdata_formatliteraldateslistdays_spanintdeltafloatdisplay_namestrfrom_datedatetimelanguageliterallocaleliteralmedianfloatmetric_namestrserieslistto_datedatetimevaluefloatGetTopicsResponseItemShareOfVoice
optional
Hide ParametersShow Parameters
averagefloat
optional
formatdouble
data_formatliteral
optional
Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]
Hide ParametersShow Parameters
"NUMBER"
"PERCENTAGE"
"CURRENCY"
"TEXT"
"SCORE"
dateslist
optional
Optional[List[datetime]]
days_spanint
optional
formatint32
deltafloat
optional
formatdouble
display_namestr
optional
from_datedatetime
optional
formatdate-time
languageliteral
optional
Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
localeliteral
optional
Optional[Literal["GLOBAL", "ISRAEL", "EU", 97 more]]
Hide ParametersShow Parameters
"GLOBAL"
"ISRAEL"
"EU"
"UK"
"US"
"IL"
"AL"
"AZ"
"KG"
"BA"
"UZ"
"BI"
"XK"
"SM"
"DE"
"AT"
"CH"
"IE"
"IM"
"FR"
"ES"
"NL"
"IT"
"PT"
"BE"
"AD"
"MT"
"MC"
"MA"
"LU"
"TN"
"DZ"
"GI"
"LI"
"SE"
"DK"
"FI"
"NO"
"AX"
"IS"
"GG"
"JE"
"GL"
"VA"
"FX"
"FO"
"AF"
"AM"
"AU"
"BH"
"BD"
"BT"
"BN"
"KH"
"CN"
"CY"
"GE"
"HK"
"IN"
"ID"
"IR"
"IQ"
"JP"
"JO"
"KZ"
"KW"
"LA"
"LB"
"MY"
"MV"
"MN"
"MM"
"NP"
"OM"
"PK"
"PH"
"QA"
"SA"
"SG"
"KR"
"LK"
"SY"
"TW"
"TH"
"TR"
"AE"
"VN"
"YE"
"AR"
"BO"
"BR"
"CL"
"CO"
"EC"
"GY"
"PY"
"PE"
"SR"
"UY"
"VE"
medianfloat
optional
formatdouble
metric_namestr
optional
serieslist
optional
Optional[List[GetTopicsResponseItemShareOfVoiceSery]]
Hide ParametersShow Parameters
datedatetime
formatdate-time
valuefloat
formatdouble
to_datedatetime
optional
formatdate-time
valuefloat
optional
formatdouble
startedbool
optional
topicidstrarchivedboollanguageliterallast_rundatetimellm_providerstrlocaleliteralpromptslistseo_keyword_indexinttagslisttextstrwebsite_idstrGetTopicsResponseItemTopic
optional
Hide ParametersShow Parameters
idstr
optional
archivedbool
optional
languageliteral
optional
Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
last_rundatetime
optional
formatdate-time
llm_providerstr
optional
localeliteral
optional
Optional[Literal["GLOBAL", "ISRAEL", "EU", 97 more]]
Hide ParametersShow Parameters
"GLOBAL"
"ISRAEL"
"EU"
"UK"
"US"
"IL"
"AL"
"AZ"
"KG"
"BA"
"UZ"
"BI"
"XK"
"SM"
"DE"
"AT"
"CH"
"IE"
"IM"
"FR"
"ES"
"NL"
"IT"
"PT"
"BE"
"AD"
"MT"
"MC"
"MA"
"LU"
"TN"
"DZ"
"GI"
"LI"
"SE"
"DK"
"FI"
"NO"
"AX"
"IS"
"GG"
"JE"
"GL"
"VA"
"FX"
"FO"
"AF"
"AM"
"AU"
"BH"
"BD"
"BT"
"BN"
"KH"
"CN"
"CY"
"GE"
"HK"
"IN"
"ID"
"IR"
"IQ"
"JP"
"JO"
"KZ"
"KW"
"LA"
"LB"
"MY"
"MV"
"MN"
"MM"
"NP"
"OM"
"PK"
"PH"
"QA"
"SA"
"SG"
"KR"
"LK"
"SY"
"TW"
"TH"
"TR"
"AE"
"VN"
"YE"
"AR"
"BO"
"BR"
"CL"
"CO"
"EC"
"GY"
"PY"
"PE"
"SR"
"UY"
"VE"
promptslist
optional
Optional[List[GetTopicsResponseItemTopicPrompt]]
Hide ParametersShow Parameters
idstr
optional
languageliteral
optional
Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
textstr
optional
seo_keyword_indexint
optional
formatint64
tagslist
optional
Optional[List[GetTopicsResponseItemTopicTag]]
Hide ParametersShow Parameters
color_hexstr
namestr
website_topic_idstr
deprecated
idstr
optional
topic_idslist
optional
Optional[List[str]]
textstr
optional
website_idstr
optional
from anvil import Anvil

client = Anvil(
    api_key="My API Key",
)
response = client.get_topics(
    from_date=0,
    llm_provider="llmProvider",
    tag_ids=["string"],
    to_date=0,
)
print(response)
200 Example
[
  {
    "archived": true,
    "averageRanking": {
      "average": 0,
      "dataFormat": "NUMBER",
      "dates": [
        "2019-12-27T18:11:19.117Z"
      ],
      "daysSpan": 0,
      "delta": 0,
      "displayName": "displayName",
      "fromDate": "2019-12-27T18:11:19.117Z",
      "language": "ENGLISH",
      "locale": "GLOBAL",
      "median": 0,
      "metricName": "metricName",
      "series": [
        {
          "date": "2019-12-27T18:11:19.117Z",
          "value": 0
        }
      ],
      "toDate": "2019-12-27T18:11:19.117Z",
      "value": 0
    },
    "mentionRate": {
      "average": 0,
      "dataFormat": "NUMBER",
      "dates": [
        "2019-12-27T18:11:19.117Z"
      ],
      "daysSpan": 0,
      "delta": 0,
      "displayName": "displayName",
      "fromDate": "2019-12-27T18:11:19.117Z",
      "language": "ENGLISH",
      "locale": "GLOBAL",
      "median": 0,
      "metricName": "metricName",
      "series": [
        {
          "date": "2019-12-27T18:11:19.117Z",
          "value": 0
        }
      ],
      "toDate": "2019-12-27T18:11:19.117Z",
      "value": 0
    },
    "promptsCount": 0,
    "roi": 0,
    "searchVolume": 0,
    "shareOfVoice": {
      "average": 0,
      "dataFormat": "NUMBER",
      "dates": [
        "2019-12-27T18:11:19.117Z"
      ],
      "daysSpan": 0,
      "delta": 0,
      "displayName": "displayName",
      "fromDate": "2019-12-27T18:11:19.117Z",
      "language": "ENGLISH",
      "locale": "GLOBAL",
      "median": 0,
      "metricName": "metricName",
      "series": [
        {
          "date": "2019-12-27T18:11:19.117Z",
          "value": 0
        }
      ],
      "toDate": "2019-12-27T18:11:19.117Z",
      "value": 0
    },
    "started": true,
    "topic": {
      "id": "id",
      "archived": true,
      "language": "ENGLISH",
      "lastRun": "2019-12-27T18:11:19.117Z",
      "llmProvider": "llmProvider",
      "locale": "GLOBAL",
      "prompts": [
        {
          "id": "id",
          "language": "ENGLISH",
          "text": "text"
        }
      ],
      "seoKeywordIndex": 0,
      "tags": [
        {
          "colorHex": "colorHex",
          "name": "name",
          "websiteTopicId": "websiteTopicId",
          "id": "id",
          "topicIds": [
            "string"
          ]
        }
      ],
      "text": "text",
      "websiteId": "websiteId"
    }
  }
]