Prompts
List a brand's prompts, filtered, sorted and paged.
apiKeyx-api-key<token>Workspace API key from Settings > API keys. Also accepted as Authorization: Bearer gsk_...
brandId*stringuuidq?stringMatches prompt text
length <= 200types?stringComma-separated prompt types
length <= 2000intents?stringComma-separated intents
length <= 2000country?stringCountry code, or global for prompts without a country
^([a-z]{2}|global)$from?stringCreated on or after this UTC date
^\d{4}-\d{2}-\d{2}$to?stringCreated on or before this UTC date
^\d{4}-\d{2}-\d{2}$engines?stringComma-separated engine slugs; applies once runs exist
length <= 2000tagIds?stringComma-separated prompt tag ids; matches any of them
length <= 2000topicIds?stringComma-separated topic ids; matches any of them
length <= 2000status?stringOmit for every prompt
"enabled""disabled"sort?string"created""text""type""country""created""visibility"order?string"desc""asc""desc"page?integer1 <= value1pageSize?integer1 <= value <= 10025One page of prompts with type and intent counts
application/jsonitems*array<>total*integerpage*integerpageSize*integermix*Type and intent counts for the current filters
locations*array<>Every location the brand's prompts use, with counts
brandCountryCode*string|nullcurl -X GET 'https://app.gensiv.com/api/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/prompts'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "text": "string", "type": "organic", "intent": "informational", "countryCode": "string", "source": "ai", "enabled": true, "metrics": { "visibility": 0, "sentiment": 0, "mentioned": 0, "responses": 0 }, "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "topics": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "color": "string" } ], "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0, "mix": { "types": { "organic": 0, "brand_specific": 0, "competitor_comparison": 0 }, "intents": { "informational": 0, "commercial": 0, "navigational": 0, "branded": 0 } }, "locations": [ { "countryCode": "string", "count": 0 } ], "brandCountryCode": "string"}curl -X GET 'https://app.gensiv.com/api/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/prompts'{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"text": "string",
"type": "organic",
"intent": "informational",
"countryCode": "string",
"source": "ai",
"enabled": true,
"metrics": {
"visibility": 0,
"sentiment": 0,
"mentioned": 0,
"responses": 0
},
"tags": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"topics": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"color": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z"
}
],
"total": 0,
"page": 0,
"pageSize": 0,
"mix": {
"types": {
"organic": 0,
"brand_specific": 0,
"competitor_comparison": 0
},
"intents": {
"informational": 0,
"commercial": 0,
"navigational": 0,
"branded": 0
}
},
"locations": [
{
"countryCode": "string",
"count": 0
}
],
"brandCountryCode": "string"
}