Documentation

/api/clients routes

92 routes under /api/clients that an account can call. Columns are explained on the HTTP routes page; type a path, a scope or a tool name to filter.

/api/clients (92)

MethodsPathScope402ReceiptAccessTools
GET POST PUT DELETE/api/clientsclient-config:read client-config:writekey
GET PUT PATCH DELETE/api/clients/[id]client-config:read client-config:writekey
GET/api/clients/[id]/activityclient-config:readkey
GET/api/clients/[id]/anchor-overviewclient-config:readkey
POST DELETE/api/clients/[id]/archiveclient-config:writeself-serve key
GET/api/clients/[id]/backlinks/index-statusllm-tracking:readkeycitation_check_index_status
GET PUT/api/clients/[id]/brand-aliasesclient-config:read client-config:writekey
GET PATCH/api/clients/[id]/brand-intelligence/briefclient-config:write orders:read topic-gen:readkeybrand_brief_get
POST/api/clients/[id]/brand-intelligence/cancelorders:writekey
POST/api/clients/[id]/brand-intelligence/generate-brieforders:writekey
GET/api/clients/[id]/brand-intelligence/latestorders:readkey
POST/api/clients/[id]/brand-intelligence/manual-brieforders:write topic-gen:writekeybrand_brief_save
POST/api/clients/[id]/brand-intelligence/start-researchorders:writekey
GET/api/clients/[id]/brand-intelligence/statusclient-config:readkey
POST/api/clients/[id]/brand-intelligence/submit-direct-answersorders:writekey
POST/api/clients/[id]/brand-intelligence/submit-inputorders:writekey
GET POST/api/clients/[id]/bulk-analysisorders:read orders:writekey
GET PUT DELETE/api/clients/[id]/bulk-analysis/[domainId]orders:writekey
POST/api/clients/[id]/bulk-analysis/ai-qualifyorders:writekey
POST/api/clients/[id]/bulk-analysis/analyze-dataforseo/check-cacheorders:readkey
PUT DELETE/api/clients/[id]/bulk-analysis/bulkorders:writekey
POST/api/clients/[id]/bulk-analysis/checkorders:readkey
GET/api/clients/[id]/bulk-analysis/dataforseo/check-analyzedorders:readkey
GET/api/clients/[id]/bulk-analysis/dataforseo/resultsorders:readkey
GET/api/clients/[id]/bulk-analysis/domainsorders:readkey
GET/api/clients/[id]/bulk-analysis/exportorders:readkey
GET POST/api/clients/[id]/bulk-analysis/master-qualifyorders:write402receiptkey
PUT/api/clients/[id]/bulk-analysis/moveorders:writekey
POST/api/clients/[id]/bulk-analysis/prescreen-estimateorders:write402receiptkey
POST/api/clients/[id]/bulk-analysis/refreshorders:writekey
POST/api/clients/[id]/bulk-analysis/target-matchorders:writekey
GET POST PUT PATCH DELETE/api/clients/[id]/content-strategyclient-config:write orders:readkey
GET/api/clients/[id]/content-strategy/distributionorders:readkey
GET/api/clients/[id]/content-strategy/keywordsorders:readkey
GET/api/clients/[id]/domains-in-ordersorders:readkey
GET POST DELETE/api/clients/[id]/excluded-domainsclient-config:read client-config:writekey
POST/api/clients/[id]/excluded-domains/import-dataforseoorders:writekey
GET PUT/api/clients/[id]/fact-check-instructionsclient-config:read client-config:writekeyclient_fact_check_instructions_get client_fact_check_instructions_update
POST/api/clients/[id]/import-backlinks/bulkorders:writekey
GET PUT/api/clients/[id]/li-preferencesclient-config:read client-config:writekeyclient_li_preferences_get client_li_preferences_update
GET/api/clients/[id]/llm-tracking/backlinksllm-tracking:readkeyclient_llm_backlinks
GET/api/clients/[id]/llm-tracking/backlinks/[lineItemId]/historyllm-tracking:readkeyclient_llm_backlink_history
GET POST DELETE/api/clients/[id]/llm-tracking/backlinks/[lineItemId]/keywordsllm-tracking:read llm-tracking:writekeyclient_llm_backlink_keyword_add client_llm_backlink_keyword_delete client_llm_backlink_keywords_list
POST/api/clients/[id]/llm-tracking/backlinks/deletellm-tracking:writekeyclient_llm_backlink_delete
POST/api/clients/[id]/llm-tracking/backlinks/extract-keywordsllm-tracking:write402receiptkeyclient_llm_backlink_extract_keywords
POST/api/clients/[id]/llm-tracking/backlinks/tagsllm-tracking:writekeyclient_llm_backlink_tags_set
GET POST/api/clients/[id]/llm-tracking/checkllm-tracking:read llm-tracking:write402keyclient_llm_check_cost_estimate
POST/api/clients/[id]/llm-tracking/check-asyncllm-tracking:write402receiptkeyclient_llm_check_async
GET/api/clients/[id]/llm-tracking/check-historyllm-tracking:readkeyclient_llm_check_history
GET PUT/api/clients/[id]/llm-tracking/check-settingsllm-tracking:read llm-tracking:writekeyclient_llm_check_settings_get client_llm_check_settings_set
GET/api/clients/[id]/llm-tracking/check-statusllm-tracking:readkeyclient_llm_check_status
GET/api/clients/[id]/llm-tracking/comparisonllm-tracking:readkeyclient_llm_comparison
GET/api/clients/[id]/llm-tracking/exportllm-tracking:readkeyclient_llm_export
GET POST/api/clients/[id]/llm-tracking/extract-keywordsllm-tracking:read llm-tracking:write402receiptkeyclient_llm_extract_keywords client_llm_extract_keywords_status
GET POST/api/clients/[id]/llm-tracking/importllm-tracking:read llm-tracking:writekeyclient_llm_import client_llm_import_list
GET/api/clients/[id]/llm-tracking/import/[batchId]/statusllm-tracking:readkeyclient_llm_import_status
POST/api/clients/[id]/llm-tracking/keyword-cloud-batchllm-tracking:write402receiptkeyclient_llm_keyword_cloud_batch
GET/api/clients/[id]/llm-tracking/keyword-groupsllm-tracking:readkeyclient_llm_keyword_groups_list
POST/api/clients/[id]/llm-tracking/keyword-groups/setllm-tracking:writekeyclient_llm_keyword_groups_set
GET PUT/api/clients/[id]/llm-tracking/keyword-locationsllm-tracking:read llm-tracking:writekeyclient_llm_keyword_locations
POST/api/clients/[id]/llm-tracking/keyword-retirellm-tracking:writekeyclient_llm_keyword_retire
GET POST/api/clients/[id]/llm-tracking/keywordsllm-tracking:read llm-tracking:writekeyclient_llm_keyword_add client_llm_keywords
GET/api/clients/[id]/llm-tracking/keywords/[keyword]/historyllm-tracking:readkeyclient_llm_keyword_history
POST/api/clients/[id]/llm-tracking/keywords/bulk-addllm-tracking:writekeyclient_llm_keywords_bulk_add
GET/api/clients/[id]/llm-tracking/keywords/suggest-backlinksllm-tracking:readkeyclient_llm_keyword_suggest_backlinks
GET/api/clients/[id]/llm-tracking/mentionsllm-tracking:readkeyclient_llm_mentions
GET POST/api/clients/[id]/llm-tracking/saved-searchesllm-tracking:read llm-tracking:writekeyclient_llm_saved_search_create client_llm_saved_searches_list
PATCH DELETE/api/clients/[id]/llm-tracking/saved-searches/[searchId]llm-tracking:writekeyclient_llm_saved_search_delete client_llm_saved_search_update
GET POST/api/clients/[id]/llm-tracking/sharellm-tracking:read llm-tracking:writekeyclient_llm_share_create client_llm_share_list
DELETE/api/clients/[id]/llm-tracking/share/[linkId]llm-tracking:writekeyclient_llm_share_delete
GET/api/clients/[id]/llm-tracking/statsllm-tracking:readkeyclient_llm_stats
GET PUT/api/clients/[id]/market-contextclient-config:read client-config:writekeyclient_market_context_get client_market_context_update
GET POST/api/clients/[id]/market-context/generateorders:write402receiptkey
GET PUT/api/clients/[id]/metrics-criteriaclient-config:read client-config:writekeyclient_metrics_criteria_get client_metrics_criteria_update
GET PUT/api/clients/[id]/outline-preferencesclient-config:read client-config:writekeyclient_outline_preferences_get client_outline_preferences_update
GET PUT/api/clients/[id]/page-type-rulesclient-config:read client-config:writekey
GET/api/clients/[id]/plan-alignmentclient-config:readkey
GET POST/api/clients/[id]/plansclient-config:read client-config:writekey
GET PATCH DELETE/api/clients/[id]/plans/[planId]client-config:write orders:readkey
GET POST/api/clients/[id]/plans/[planId]/shareorders:writekey
DELETE/api/clients/[id]/plans/[planId]/share/[linkId]orders:writekey
GET POST/api/clients/[id]/projectsclient-config:read client-config:writekey
GET PATCH DELETE/api/clients/[id]/projects/[projectId]orders:writekey
GET/api/clients/[id]/report-linksclient-config:readkey
GET PUT/api/clients/[id]/servicesclient-config:read client-config:write402receiptself-serve key
GET/api/clients/[id]/statsclient-config:readkey
GET/api/clients/[id]/target-page-activityorders:readkey
GET POST PUT PATCH DELETE/api/clients/[id]/target-pagesclient-config:read client-config:write orders:writekey
GET POST/api/clients/[id]/tier2-candidatesclient-config:read client-config:writekey
GET POST/api/clients/[id]/topic-bankllm-tracking:read llm-tracking:writekeytopic_bank_create topic_bank_get
PATCH/api/clients/[id]/topic-bank/[keywordId]llm-tracking:writekeytopic_bank_update
GET/api/clients/[id]/workflowsworkflows:readkey