Skip to content
Try for free
On this page

Integrations

Gauge

Track AI visibility and manage Gauge prompts

Gauge measures how brands appear in AI answers and which sources those answers cite.

With the Gauge block, you can:

  • Manage tracked questions: Create topics, import prompts with a dry-run preview, update tracking types, and organize prompts with tags.
  • Investigate AI answers: Read collected answers, brand mentions, citations, and search queries.
  • Report on visibility: Discover available metrics and run reports across answers, citations, search queries, and AI traffic.

Create an organization API key in Gauge under Settings → Integrations → API Keys, then connect it as a saved Gauge account in Sim. Read only supports reads and report queries; Read & write also manages topics, prompts, and tags. Reconnect with a replacement key after rotation, expiry, or revocation. Temporary CLI login tokens are not supported.

Select an organization with Gauge Chat enabled and its category. Resource pickers also have a manual ID option in advanced mode. Answer pickers show the API's default recent window; use an answer ID directly for older answers. Follow nextCursor to retrieve additional result pages. Answer and citation filters default to the last seven days.

This integration covers all 27 Gauge Chat API operations. Gauge Agents uses a separate API and is outside this block's scope. See the Gauge Chat API reference for the current limits and query catalog.

Use the block

Manage organizations, categories, topics, tracked prompts, and tags; inspect brands, AI answers, citations, and search queries; and run visibility, share-of-voice, and AI-traffic reports with the Gauge Chat API.

Actions

Gauge Get Current Credential

Read the identity, permissions, and expiry of the connected Gauge API key.

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
userjsonUser
↳ idstringId
↳ emailstringEmail
↳ namestringName
apiKeyjsonApi key
↳ idstringId
↳ namestringName
↳ prefixstringPrefix
↳ organizationjsonOrganization
↳ idstringId
↳ slugstringSlug
↳ namestringName
tokenjsonToken
↳ kindstringKind
↳ scopesarrayScopes
↳ expiresAtstringExpires at

Gauge List Organizations

List organizations and agency clients accessible to the connected API key.

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
organizationsarrayOrganizations
↳ idstringId
↳ slugstringSlug
↳ namestringName
↳ productsjsonProducts
↳ chatbooleanChat
↳ agentsbooleanAgents
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Get Organization

Read an organization and its enabled Gauge products.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID

Output

ParameterTypeDescription
organizationjsonOrganization
↳ idstringId
↳ slugstringSlug
↳ namestringName
↳ productsjsonProducts
↳ chatbooleanChat
↳ agentsbooleanAgents

Gauge List Categories

List the AI-search categories configured for an organization.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID

Output

ParameterTypeDescription
categoriesarrayCategories
↳ idstringId
↳ slugstringSlug
↳ namestringName
↳ descriptionstringDescription
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Get Category

Read the details of an AI-search category.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID

Output

ParameterTypeDescription
categoryjsonCategory
↳ idstringId
↳ slugstringSlug
↳ namestringName
↳ descriptionstringDescription

Gauge List Topics

List one page of tracked-prompt topics in a category.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
cursorstringNoOpaque nextCursor from the previous page
limitnumberNoMaximum results to return (1–200; defaults to 50)

Output

ParameterTypeDescription
topicsarrayTopics
↳ idstringId
↳ slugstringSlug
↳ titlestringTitle
↳ promptCountnumberPrompt count
↳ createdAtstringCreated at
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Create Topic

Create a topic to organize tracked prompts.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
titlestringYesTopic title (1–200 characters)

Output

ParameterTypeDescription
topicjsonTopic
↳ idstringId
↳ slugstringSlug
↳ titlestringTitle
↳ promptCountnumberPrompt count
↳ createdAtstringCreated at

Gauge Get Topic

Read a topic and its tracked-prompt count.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
topicIdstringYesTopic ID

Output

ParameterTypeDescription
topicjsonTopic
↳ idstringId
↳ slugstringSlug
↳ titlestringTitle
↳ promptCountnumberPrompt count
↳ createdAtstringCreated at

Gauge Rename Topic

Change the title of an existing topic.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
topicIdstringYesTopic ID
titlestringYesTopic title (1–200 characters)

Output

ParameterTypeDescription
topicjsonTopic
↳ idstringId
↳ slugstringSlug
↳ titlestringTitle
↳ promptCountnumberPrompt count
↳ createdAtstringCreated at

Gauge List Prompts

List one page of tracked prompts with optional topic, tag, and tracking-type filters.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
topicstringNoFilter by a single topic ID
tagjsonNoJSON array of tag IDs
trackingTypestringNoPrompt tracking type: visibility or branded_own or all
cursorstringNoOpaque nextCursor from the previous page
limitnumberNoMaximum results to return (1–200; defaults to 50)

Output

ParameterTypeDescription
promptsarrayPrompts
↳ idstringId
↳ textstringText
↳ topicIdstringTopic id
↳ trackingTypestringTracking type
↳ tagIdsarrayTag ids
↳ createdAtstringCreated at
↳ firstAnswerDaystringFirst answer day
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Create Prompts

Add a batch of tracked questions or preview the import without creating prompts.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
dryRunbooleanNoValidate the batch and report what would be created without saving prompts
promptsjsonYesJSON array of 1–500 prompts: [{"text":"Which tools work best?","topicId":"top_example","trackingType":"visibility","tagIds":[]}]

Output

ParameterTypeDescription
resultsarrayResults
↳ indexnumberIndex
↳ statusstringStatus
↳ promptjsonPrompt
↳ idstringId
↳ textstringText
↳ topicIdstringTopic id
↳ trackingTypestringTracking type
↳ tagIdsarrayTag ids
↳ createdAtstringCreated at
↳ firstAnswerDaystringFirst answer day
dryRunbooleanDry run
remainingnumberRemaining

Gauge Bulk Update Prompts

Change the topic or tracking type of up to 500 tracked prompts.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
topicIdstringNoNew topic ID; omitted values leave the topic unchanged
trackingTypestringNoPrompt tracking type: visibility or branded_own
idsjsonYesJSON array of 1–500 prompt IDs to update

Output

ParameterTypeDescription
updatedarrayUpdated
notFoundarrayNot found

Gauge Add Tags To Prompts

Apply a set of tags to the selected tracked prompts.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
promptIdsjsonYesJSON array of 1–500 prompt IDs
tagIdsjsonYesJSON array of 1–50 tag IDs

Output

ParameterTypeDescription
promptIdsarrayPrompt ids

Gauge Remove Tags From Prompts

Remove a set of tags from the selected tracked prompts.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
promptIdsjsonYesJSON array of 1–500 prompt IDs
tagIdsjsonYesJSON array of 1–50 tag IDs

Output

ParameterTypeDescription
promptIdsarrayPrompt ids

Gauge Get Prompt

Read a tracked question and its topic, tags, and sampling information.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
promptIdstringYesPrompt ID

Output

ParameterTypeDescription
promptjsonPrompt
↳ idstringId
↳ textstringText
↳ topicIdstringTopic id
↳ trackingTypestringTracking type
↳ tagIdsarrayTag ids
↳ createdAtstringCreated at
↳ firstAnswerDaystringFirst answer day

Gauge Update Prompt

Move a prompt to another topic or change its tracking type. Prompt text is immutable: create a new prompt instead.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
promptIdstringYesPrompt ID
topicIdstringNoNew topic ID; omitted values leave the topic unchanged
trackingTypestringNoPrompt tracking type: visibility or branded_own

Output

ParameterTypeDescription
promptjsonPrompt
↳ idstringId
↳ textstringText
↳ topicIdstringTopic id
↳ trackingTypestringTracking type
↳ tagIdsarrayTag ids
↳ createdAtstringCreated at
↳ firstAnswerDaystringFirst answer day

Gauge List Tags

List the tags available to organize prompts in an organization.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID

Output

ParameterTypeDescription
tagsarrayTags
↳ idstringId
↳ namestringName
↳ colorstringColor
↳ promptCountnumberPrompt count
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Create Tag

Create an organization-wide prompt tag.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
namestringYesTag name (1–120 characters)
colorstringNoTag color string (up to 20 characters)

Output

ParameterTypeDescription
tagjsonTag
↳ idstringId
↳ namestringName
↳ colorstringColor
↳ promptCountnumberPrompt count

Gauge Get Tag

Read a prompt tag and its usage count.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
tagIdstringYesTag ID

Output

ParameterTypeDescription
tagjsonTag
↳ idstringId
↳ namestringName
↳ colorstringColor
↳ promptCountnumberPrompt count

Gauge Update Tag

Change the name or color of a prompt tag.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
tagIdstringYesTag ID
namestringNoTag name (1–120 characters)
colorstringNoTag color string (up to 20 characters); omit to keep unchanged or use "" to clear

Output

ParameterTypeDescription
tagjsonTag
↳ idstringId
↳ namestringName
↳ colorstringColor
↳ promptCountnumberPrompt count

Gauge Delete Tag

Delete a prompt tag and remove its associations with prompts.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
tagIdstringYesTag ID

Output

ParameterTypeDescription
tagIdstringID of the deleted tag
deletedbooleanWhether the tag was deleted

Gauge List Brands

Your owned brands and the category's tracked competitors. Together these are the share-of-voice denominator.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID

Output

ParameterTypeDescription
brandsarrayBrands
↳ idstringId
↳ namestringName
↳ slugstringSlug
↳ websitestringWebsite
↳ rolestringRole
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Get Query Metadata

Discover available report datasets, metrics, dimensions, filters, and values.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
datasetstringNoReport dataset: answers, citations, searchQueries, or aiTraffic

Output

ParameterTypeDescription
catalogjsonDynamic dataset, metric, dimension, and filter catalog returned by Gauge

Gauge Run Report Query

Run a report on AI answers, citations, search queries, or AI bot traffic using metrics from the query catalog.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
datasetstringYesReport dataset: answers, citations, searchQueries, or aiTraffic
dimensionsjsonNoJSON array of up to 3 dimension keys from Get Query Metadata
metricsjsonYesJSON array of 1–4 metric keys from Get Query Metadata
filtersjsonNoJSON object of category, brand, model, topic, tag, tagMode, prompt, trackingType, domain, and page filters
wherejsonNoJSON array of up to 10 predicates: {"dimension":"domain","op":"contains","value":"example.com"}
dateRangejsonNoJSON object with since (YYYY-MM-DD or 30d), until (YYYY-MM-DD), or lastDays (1–400)
granularitystringNoReport time bucket: hour, day, week, or month (defaults to day)
orderByjsonNoJSON array of up to 4 sort rules: {"key":"metric_name","dir":"desc"}
limitnumberNoMaximum report rows (1–1000; defaults to 50)

Output

ParameterTypeDescription
columnsarrayColumns
↳ keystringKey
↳ kindstringKind
↳ typestringType
↳ unitstringUnit
rowsarrayRows
labelsjsonLabels
dateRangejsonDate range
↳ sincestringSince
↳ untilstringUntil
truncatedbooleanTruncated
cachedbooleanCached
freshnessjsonFreshness
↳ watermarkstringWatermark
↳ pendingnumberPending
↳ availablebooleanAvailable

Gauge List Answers

List one page of collected AI answers using date, model, prompt, and brand filters.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
sincestringNoStart date in YYYY-MM-DD format; defaults to 7 days ago
untilstringNoEnd date in YYYY-MM-DD format; defaults to today
modeljsonNoJSON array of model IDs
promptjsonNoJSON array of prompt IDs
topicjsonNoJSON array of topic IDs
tagjsonNoJSON array of tag IDs
trackingTypestringNoPrompt tracking type: visibility or branded_own or all
cursorstringNoOpaque nextCursor from the previous page
limitnumberNoMaximum results to return (1–100; defaults to 50)
brandjsonNoJSON array of brand IDs that an answer must mention
brandAbsentjsonNoJSON array of brand IDs that an answer must not mention

Output

ParameterTypeDescription
answersarrayAnswers
↳ idstringId
↳ promptIdstringPrompt id
↳ topicIdstringTopic id
↳ modelstringModel
↳ daystringDay
↳ createdAtstringCreated at
↳ textstringText
↳ brandIdsarrayBrand ids
nextCursorstringOpaque cursor for the next page; null when complete

Gauge Get Answer

Read an AI answer with its prompt, brand mentions, source citations, and searches.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
answerIdstringYesAnswer ID

Output

ParameterTypeDescription
answerjsonAnswer
↳ idstringId
↳ promptIdstringPrompt id
↳ promptTextstringPrompt text
↳ topicIdstringTopic id
↳ modelstringModel
↳ daystringDay
↳ createdAtstringCreated at
↳ textstringText
↳ mentionsarrayMentions
↳ brandIdstringBrand id
↳ namestringName
↳ mentionTypesarrayMention types
↳ countnumberCount
↳ citationsarrayCitations
↳ pageIdstringPage id
↳ urlstringUrl
↳ titlestringTitle
↳ domainstringDomain
↳ searchQueriesarraySearch queries

Gauge List Citations

List one page of sources cited by AI answers in a category.

Inputs and outputs

Input

ParameterTypeRequiredDescription
orgstringYesOrganization slug or UUID
categorystringYesCategory slug or cat_ ID
sincestringNoStart date in YYYY-MM-DD format; defaults to 7 days ago
untilstringNoEnd date in YYYY-MM-DD format; defaults to today
modeljsonNoJSON array of model IDs
promptjsonNoJSON array of prompt IDs
topicjsonNoJSON array of topic IDs
tagjsonNoJSON array of tag IDs
trackingTypestringNoPrompt tracking type: visibility or branded_own or all
cursorstringNoOpaque nextCursor from the previous page
limitnumberNoMaximum results to return (1–200; defaults to 50)
domainjsonNoJSON array of cited domains
pagejsonNoJSON array of cited page IDs

Output

ParameterTypeDescription
citationsarrayCitations
↳ answerIdstringAnswer id
↳ pageIdstringPage id
↳ promptIdstringPrompt id
↳ modelstringModel
↳ daystringDay
↳ domainstringDomain
↳ urlstringUrl
nextCursorstringOpaque cursor for the next page; null when complete

Report requirements

Answer lists support up to 100 results per page; other paginated lists support up to 200.

Read the query catalog before building reports. Visibility and share-of-voice metrics require a brand filter or brand grouping. Dataset filters and supported time granularities vary.

Was this helpful?
Suggest an edit