SearchlyDocs

Reference

API reference

Find the endpoint, required scopes, and request fields for each Searchly API operation.

On this page

Using the reference

#

All 142 operations use https://app.trysearchly.com/api/v1. Open an endpoint for its exact request parameters, body schema, scopes, and a cURL template. Start with the API quickstart if you do not have a key or project ID yet.

Download the OpenAPI specification

Workspace

#
GETRead workspace plan, limits, and usage/workspace

Models

#
GETList active measurement engines/enginesPUTSelect measurement engines within plan entitlements/projects/{projectId}/engines

Projects

#
GETList workspace projects/projectsPOSTCreate a project within plan limits/projectsGETRead a project's configuration and tracking state/projects/{projectId}PATCHUpdate project settings/projects/{projectId}

Project activation

#
POSTActivate project tracking with existing subscription checks/projects/{projectId}/activate

Project analysis

#
POSTPrepare and enqueue today's project analysis/projects/{projectId}/analysisGETRead truthful analysis and report readiness/projects/{projectId}/analysis

Brand research

#
POSTEnrich a project using existing guarded provider behavior/projects/{projectId}/enrich

Model allocation

#
PUTSet this project's share of the workspace prompt budget/projects/{projectId}/prompt-allocation

Brand profile

#
GETRead brand profile and writing guidance/projects/{projectId}/brand-profilePUTUpdate one brand writing-guidance field/projects/{projectId}/brand-profile/{field}

Competitors

#
GETList tracked competitors/projects/{projectId}/competitorsPOSTAdd a tracked competitor with existing duplicate checks/projects/{projectId}/competitorsPUTAtomically replace the curated competitor set/projects/{projectId}/competitorsDELETERemove a tracked competitor/projects/{projectId}/competitors/{competitorId}POSTDiscover competitor suggestions using stored project inputs and existing spend guards/projects/{projectId}/competitors/suggestions

Tracked domains

#
GETList the brand's owned domains/projects/{projectId}/tracked-domainsPOSTTrack an owned domain with existing classification safeguards/projects/{projectId}/tracked-domainsDELETEStop treating a tracked domain as owned/projects/{projectId}/tracked-domains/{domainId}

Topics

#
GETList project topics/projects/{projectId}/topicsPOSTCreate a project topic/projects/{projectId}/topicsPUTAtomically confirm onboarding topics/projects/{projectId}/topicsPATCHRename a project topic/projects/{projectId}/topics/{topicId}DELETEDelete a project topic/projects/{projectId}/topics/{topicId}POSTSuggest topics grounded in the project's stored website and metadata/projects/{projectId}/topics/suggestionsPOSTReplace the project's accepted topic set including explicit tags/projects/{projectId}/topics/accept

Prompts

#
GETList project prompts and tracking state/projects/{projectId}/promptsPOSTAdd tracked prompts with plan caps and submission replay protection/projects/{projectId}/promptsPUTAtomically replace and track the curated project prompt set/projects/{projectId}/promptsPOSTGenerate proposed prompts and topics with existing spend guards/projects/{projectId}/prompts/generatePOSTGenerate reviewable onboarding prompts without accepting them/projects/{projectId}/prompts/suggestionsPOSTStart tracking a proposed prompt within plan limits/projects/{projectId}/prompts/{promptId}/acceptPOSTArchive or restore a prompt using the existing lifecycle/projects/{projectId}/prompts/{promptId}/archivePOSTTrack, archive, or restore a bounded prompt batch/projects/{projectId}/prompts/bulkPUTAssign a prompt to a topic in the same project/projects/{projectId}/prompts/{promptId}/topicDELETEPermanently delete a prompt and its associated run history/projects/{projectId}/prompts/{promptId}GETRead a prompt's measurement analysis/projects/{projectId}/prompts/{promptId}/analysis

Issues

#
GETRead site audit findings and audit progress/projects/{projectId}/issuesPUTSet an issue checklist item's completion state/projects/{projectId}/issues/checklist/{code}

Website audits

#
POSTEnqueue a guarded site audit without executing worker ticks/projects/{projectId}/auditsGETList audit history/projects/{projectId}/audits

Opportunities

#
GETRead current measured opportunities/projects/{projectId}/opportunitiesPATCHMark an opportunity pending, done, or declined/projects/{projectId}/opportunities/{opportunityId}POSTEnqueue guarded opportunity analysis without worker ticks/projects/{projectId}/opportunities/refresh

Traffic

#
POSTAdd a traffic chart annotation to the explicit project/projects/{projectId}/traffic/annotationsGETList annotations for a bounded date window/projects/{projectId}/traffic/annotationsDELETEDelete a traffic chart annotation from this project/projects/{projectId}/traffic/annotations/{annotationId}GETRead Google Analytics traffic and receipt coverage/projects/{projectId}/traffic/ga4GETRead Search Console traffic and receipt coverage/projects/{projectId}/traffic/gscGETRead GA4 pages, devices, acquisition and countries/projects/{projectId}/traffic/ga4/breakdowns

Integrations

#
GETRead integration metadata and non-secret configuration/projects/{projectId}/integrationsGETGet a browser URL for interactive provider consent/projects/{projectId}/integrations/{provider}/setupPUTConfigure a pending Google connection and atomically queue backfill/projects/{projectId}/integrations/{connectionId}/configPUTValidate and configure an authorized Webflow collection/projects/{projectId}/integrations/{connectionId}/webflow-configDELETEDisconnect Google or revoke Webflow authorization safely/projects/{projectId}/integrations/{connectionId}GETList authorized Analytics properties without exposing credentials/projects/{projectId}/integrations/google/propertiesGETList authorized Search Console sites without credentials/projects/{projectId}/integrations/google/sitesGETList the authorized Webflow site/projects/{projectId}/integrations/webflow/sitesGETList an authorized Webflow site's collections/projects/{projectId}/integrations/webflow/collectionsGETRead an authorized collection's fields and schema fingerprint/projects/{projectId}/integrations/webflow/collections/{collectionId}

Crawler sources

#
POSTCreate a crawler source and reveal its token once/projects/{projectId}/crawler-sourcesPATCHRotate a crawler token with an expected-generation check; the previous token keeps working for 24 hours/projects/{projectId}/crawler-sources/{connectionId}DELETERevoke a crawler source with existing race protection/projects/{projectId}/crawler-sources/{connectionId}

Optimization proposals

#
GETRead retained optimization proposals and their frozen evidence/projects/{projectId}/optimization-proposalsPOSTCreate a bounded proposal with frozen measurement evidence/projects/{projectId}/optimization-proposalsPATCHApprove, reject, or revoke a proposal using existing version/hash guards/projects/{projectId}/optimization-proposals/{proposalId}

Content Studio

#
GETList content projects with cursor pagination/projects/{projectId}/contentPOSTCreate an Article or writer-brief project idempotently/projects/{projectId}/contentGETRead a content document and revision/projects/{projectId}/content/{contentId}DELETEDelete a draft while preserving publication boundaries/projects/{projectId}/content/{contentId}PATCHSet draft, review or archived state/projects/{projectId}/content/{contentId}/statusPATCHSave tags against an expected document revision/projects/{projectId}/content/{contentId}/tagsPATCHSave a title against an expected document revision/projects/{projectId}/content/{contentId}/titlePUTSave blocks and title against an expected revision/projects/{projectId}/content/{contentId}/documentPUTEdit the writer brief against an expected brief revision/projects/{projectId}/content/{contentId}/briefGETRead bounded Studio context, proposals, readiness and delivery state/projects/{projectId}/content/{contentId}/studioGETRead the latest 100 content messages with truncation metadata/projects/{projectId}/content/{contentId}/messagesPOSTCreate or replay deterministic content setup questions/projects/{projectId}/content/{contentId}/questionsPOSTVerify and attach a public source idempotently/projects/{projectId}/content/{contentId}/sourcesDELETERemove a source from this content project/projects/{projectId}/content/{contentId}/sources/{sourceId}POSTAccept or reject a revision proposal/projects/{projectId}/content/{contentId}/proposals/{proposalId}/decisionGETList 20 edit versions with a revision cursor/projects/{projectId}/content/{contentId}/historyGETPreview a saved version of this document/projects/{projectId}/content/{contentId}/history/{versionId}POSTRestore a saved version against an expected revision/projects/{projectId}/content/{contentId}/history/{versionId}/restorePOSTRecord readiness for the exact current document and sources/projects/{projectId}/content/{contentId}/readinessPOSTQueue idempotent initial generation or a scoped revision/projects/{projectId}/content/{contentId}/generationGETPoll a durable generation job and resulting proposal/projects/{projectId}/content/{contentId}/generation/{jobId}POSTApprove the exact current ready-to-publish version/projects/{projectId}/content/{contentId}/approvalPOSTQueue an approved version for Webflow draft or live delivery/projects/{projectId}/content/{contentId}/publishingGETRead approval and paginated provider delivery status/projects/{projectId}/content/{contentId}/publishingPOSTRetry an eligible delivery while retaining approval safeguards/projects/{projectId}/content/{contentId}/publishing/retry

AEO analytics

#
GETVisibility per AI platform/projects/{projectId}/analytics/overviewGETVisibility over time/projects/{projectId}/analytics/visibilityGETCompetitor visibility ranking/projects/{projectId}/analytics/visibility-rankingGETCompetitor visibility over time/projects/{projectId}/analytics/visibility-competitorsGETShare of voice by competitor/projects/{projectId}/analytics/share-of-voiceGETShare of voice over time/projects/{projectId}/analytics/share-of-voice-seriesGETAverage mention position over time/projects/{projectId}/analytics/average-positionGETAverage-position ranking/projects/{projectId}/analytics/position-rankingGETTopic rankings and prompt positions/projects/{projectId}/analytics/topic-rankingsGETOverview topic visibility and citation breakdown/projects/{projectId}/analytics/topic-breakdownGETTopic distribution/projects/{projectId}/analytics/topic-distributionGETTopic positions by engine/projects/{projectId}/analytics/topic-positionsGETAI platform comparison matrix/projects/{projectId}/analytics/modelsGETSelected canonical metric by platform/projects/{projectId}/analytics/metric-seriesGETOwn-brand mention trend/projects/{projectId}/analytics/mentionsGETOwn-domain citation trend/projects/{projectId}/analytics/citationsGETSentiment over time/projects/{projectId}/analytics/sentimentGETSentiment scores and themes/projects/{projectId}/analytics/sentiment-breakdownGETPositive, neutral and negative sentiment over time/projects/{projectId}/analytics/sentiment-stackedGETLatest Searchly brand-perception assessment/projects/{projectId}/analytics/perceptionGETBrand and competitor comparison/projects/{projectId}/analytics/head-to-headGETCitation share over time/projects/{projectId}/analytics/citation-shareGETCitation domain ranking/projects/{projectId}/analytics/citation-domainsGETTop cited pages/projects/{projectId}/analytics/citation-pagesGETCited content-type breakdown/projects/{projectId}/analytics/citation-typesGETCitation-domain trends/projects/{projectId}/analytics/citation-domain-seriesGETCited URLs and source classifications/projects/{projectId}/analytics/cited-urlsGETCompetitor citation-domain gaps/projects/{projectId}/analytics/citation-gapGETCompetitor content-type gaps/projects/{projectId}/analytics/content-type-gapGETMention-position distribution/projects/{projectId}/analytics/position-distributionGETDecision-journey funnel breakdown/projects/{projectId}/analytics/funnelGETObserved query fan-outs/projects/{projectId}/analytics/fanoutsGETSite health and audit history/projects/{projectId}/analytics/site-healthGETAnalyze one project prompt/projects/{projectId}/analytics/prompts/{promptId}

Answers

#
GETList raw observed answers with collection provenance/projects/{projectId}/answersGETStream raw answer history as CSV/projects/{projectId}/answers/exportGETRead an immutable answer capture and its provenance/projects/{projectId}/answers/{answerId}GETRead parsed answer citations with pagination/projects/{projectId}/answers/{answerId}/citationsGETRead parsed answer mentions with pagination/projects/{projectId}/answers/{answerId}/mentions

Agent Analytics

#
GETRead crawler connection state without credentials/projects/{projectId}/agent-analytics/crawler-sourcesGETRead retained crawler events with bounded pagination/projects/{projectId}/agent-analytics/crawler-eventsGETJoin observed answer citations, AI referrals and search traffic on one evidence day/projects/{projectId}/agent-analytics/evidenceGETRead Page Records with activity pagination and evidence coverage/projects/{projectId}/agent-analytics/pagesGETRead a Page Record for a precise project URL/projects/{projectId}/agent-analytics/pageGETRead bounded active, completed and failed rechecks/projects/{projectId}/agent-analytics/rechecks

AI shopping

#
GETRead the AI shopping report for a date window/projects/{projectId}/shoppingGETRead the product shelves ChatGPT showed for one prompt/projects/{projectId}/shopping/prompts/{promptId}GETRead every appearance of one product in ChatGPT answers/projects/{projectId}/shopping/product
↑ ↓ to navigateesc to close
API documentation