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

Get Aggregated Prompts

API Reference
Client
Get metrics for prompts with frequency data by topic ID
post/api/beta/prompts

Returns metrics for all prompts with frequency over time topic ID

Query Parameters
websiteTopicIdstring
Body Parameters
fromDatenumber
formatint64
llmProviderstring
tagIdsarray of string
toDatenumber
formatint64
Returns
answerTextstring
optional
importantTermsarray of string
optional
invocationsnumber
optional
formatint32
latestRunDatastring
optional
formatdate-time
mentionFrequencyobject
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
negativeSentimentsarray of map
optional
positiveSentimentsarray of map
optional
promptstring
optional
promptAnalysisIdstring
optional
promptIdstring
optional
promptsCountnumber
optional
formatint32
rankingnumber
optional
formatdouble
seoMetricsobject
optional
Hide ParametersShow Parameters
cpcnumber
optional
formatdouble
searchVolumenumber
optional
formatint32
shareOfVoicenumber
optional
formatdouble
sourcesarray of string
optional
curl https://api.joinanvil.com/api/beta/api/beta/prompts \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ANVIL_API_KEY" \
    -d '{
      "fromDate": 0,
      "llmProvider": "llmProvider",
      "tagIds": [
        "string"
      ],
      "toDate": 0
    }'
200 Example
[
  {
    "answerText": "answerText",
    "importantTerms": [
      "string"
    ],
    "invocations": 0,
    "latestRunData": "2019-12-27T18:11:19.117Z",
    "mentionFrequency": {
      "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
    },
    "negativeSentiments": [
      {
        "foo": "string"
      }
    ],
    "positiveSentiments": [
      {
        "foo": "string"
      }
    ],
    "prompt": "prompt",
    "promptAnalysisId": "promptAnalysisId",
    "promptId": "promptId",
    "promptsCount": 0,
    "ranking": 0,
    "seoMetrics": {
      "cpc": 0,
      "searchVolume": 0
    },
    "shareOfVoice": 0,
    "sources": [
      "string"
    ]
  }
]