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

Get Topics

API Reference
Client
Get metrics for all the topics by website ID
post/api/beta/topics

Returns metrics for all the topics by website ID

Body Parameters
fromDatenumber
formatint64
llmProviderstring
tagIdsarray of string
toDatenumber
formatint64
archiveboolean
optional
competitorUrlstring
optional
Returns
archivedboolean
optional
averageRankingobject
optional
Hide ParametersShow Parameters
averagenumber
optional
formatdouble
dataFormatenum
optional
"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more
Hide ParametersShow Parameters
"NUMBER"
"PERCENTAGE"
"CURRENCY"
"TEXT"
"SCORE"
datesarray of string
optional
daysSpannumber
optional
formatint32
deltanumber
optional
formatdouble
displayNamestring
optional
fromDatestring
optional
formatdate-time
languageenum
optional
"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
localeenum
optional
"GLOBAL" OR "ISRAEL" OR "EU" OR 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"
mediannumber
optional
formatdouble
metricNamestring
optional
seriesarray of object
optional
Hide ParametersShow Parameters
datestring
formatdate-time
valuenumber
formatdouble
toDatestring
optional
formatdate-time
valuenumber
optional
formatdouble
mentionRateobject
optional
Hide ParametersShow Parameters
averagenumber
optional
formatdouble
dataFormatenum
optional
"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more
Hide ParametersShow Parameters
"NUMBER"
"PERCENTAGE"
"CURRENCY"
"TEXT"
"SCORE"
datesarray of string
optional
daysSpannumber
optional
formatint32
deltanumber
optional
formatdouble
displayNamestring
optional
fromDatestring
optional
formatdate-time
languageenum
optional
"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
localeenum
optional
"GLOBAL" OR "ISRAEL" OR "EU" OR 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"
mediannumber
optional
formatdouble
metricNamestring
optional
seriesarray of object
optional
Hide ParametersShow Parameters
datestring
formatdate-time
valuenumber
formatdouble
toDatestring
optional
formatdate-time
valuenumber
optional
formatdouble
promptsCountnumber
optional
formatint32
roinumber
optional
formatdouble
searchVolumenumber
optional
formatint32
shareOfVoiceobject
optional
Hide ParametersShow Parameters
averagenumber
optional
formatdouble
dataFormatenum
optional
"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more
Hide ParametersShow Parameters
"NUMBER"
"PERCENTAGE"
"CURRENCY"
"TEXT"
"SCORE"
datesarray of string
optional
daysSpannumber
optional
formatint32
deltanumber
optional
formatdouble
displayNamestring
optional
fromDatestring
optional
formatdate-time
languageenum
optional
"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
localeenum
optional
"GLOBAL" OR "ISRAEL" OR "EU" OR 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"
mediannumber
optional
formatdouble
metricNamestring
optional
seriesarray of object
optional
Hide ParametersShow Parameters
datestring
formatdate-time
valuenumber
formatdouble
toDatestring
optional
formatdate-time
valuenumber
optional
formatdouble
startedboolean
optional
topicobject
optional
Hide ParametersShow Parameters
idstring
optional
archivedboolean
optional
languageenum
optional
"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
lastRunstring
optional
formatdate-time
llmProviderstring
optional
localeenum
optional
"GLOBAL" OR "ISRAEL" OR "EU" OR 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"
promptsarray of object
optional
Hide ParametersShow Parameters
idstring
optional
languageenum
optional
"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
textstring
optional
seoKeywordIndexnumber
optional
formatint64
tagsarray of object
optional
Hide ParametersShow Parameters
colorHexstring
namestring
websiteTopicIdstring
deprecated
idstring
optional
topicIdsarray of string
optional
textstring
optional
websiteIdstring
optional
curl https://api.joinanvil.com/api/beta/api/beta/topics \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ANVIL_API_KEY" \
    -d '{
      "fromDate": 0,
      "llmProvider": "llmProvider",
      "tagIds": [
        "string"
      ],
      "toDate": 0
    }'
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"
    }
  }
]