SEO research, AI visibility, content, leads, and backlink workflows. Sign in with RanklyBee OAuth.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Start a reviewed content plan so its briefs are written on their scheduled dates.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Start a reviewed content plan so its briefs are written on their scheduled dates.
| Argument | Type | Description |
|---|---|---|
| planId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"planId"
],
"properties": {
"planId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Start a campaign so its approved posts are published on schedule. Confirm with the user first.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| campaignId* | string | |
| confirmStackedChange | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"campaignId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"campaignId": {
"type": "string",
"minLength": 1
},
"confirmStackedChange": {
"type": "boolean"
}
}
}Save a brand seen in AI answers as a competitor in the site profile.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| domain* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"name",
"domain"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"domain": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add keywords to the content plan as article briefs, optionally on a given date. Returns the keywords that were skipped and why.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| phrases* | array | |
| projectId* | string | |
| scheduledDate | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"phrases"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"phrases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 10,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"scheduledDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
}
}
}Start tracking a backlink: the page that links (sourceUrl) and the page it links to (targetUrl).
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| source* | string | |
| category | string | |
| threadId | string | |
| projectId* | string | |
| sourceUrl* | string | |
| targetUrl* | string | |
| prospectId | any | |
| expectedRel | array | |
| pricingMode | string | |
| priceCurrency | string | |
Add a page of the website that articles should link to.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| title* | any | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"url",
"title"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add keywords to search for link prospects.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| phrases* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"phrases"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"phrases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 100,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add a page as a link prospect and score it.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Crawl the website again and rebuild its profile. Runs in the background; poll get_site_profile for the result.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| idempotencyKey* | string | |
| reviewFoundation | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
},
"reviewFoundation": {
"type": "boolean",
"default": false
}
}
}Apply an approved improvement to its article. Confirm with the user first.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| improvementId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
}
}
}Approve posts for publishing to the user's social accounts. Show the user each post first.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| postIds* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"postIds"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"postIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 200,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read a page and extract talking points for social posts.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| pageUrl* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"pageUrl"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"pageUrl": {
"type": "string",
"format": "uri"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add up to 100 prompts at once. Counts against the plan's prompt limit.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| monitors* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitors"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"monitors": {
"type": "array",
"items": {
"type": "object",
"required": [
"question",
"keywords",
"brandAliases",
"engines",
"frequency"
],
"properties": {
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1
},
"topicId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"category": {
"anyOf": [
{
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 25
},
"question": {
"type": "string",
"maxLength": 1000,
"minLength": 10
},
"frequency": {
"enum": [
"manual",
"daily",
"weekly"
],
"type": "string"
},
"volumeTier": {
"anyOf": [
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
{
"type": "null"
}
]
},
"brandAliases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 2
},
"maxItems": 20,
"minItems": 1
}
}
},
"maxItems": 100,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Cancel a campaign and remove its unpublished posts from the connected social scheduler.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| campaignId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"campaignId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"campaignId": {
"type": "string",
"minLength": 1
}
}
}Fetch the linking page and record whether the backlink is still live.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| backlinkId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"backlinkId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"backlinkId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
}
}Queue a live check for every tracked backlink of a website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| idempotencyPrefix* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"idempotencyPrefix"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyPrefix": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Close a tracked backlink with a reason.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| siteId* | string | |
| projectId* | string | |
| backlinkId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"backlinkId",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"backlinkId": {
"type": "string",
"minLength": 1
}
}
}Compare search performance before and after an applied improvement and record the result.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| improvementId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
}
}
}Add a prompt to track across AI engines. Counts against the plan's prompt limit.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| monitor* | object | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitor"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"monitor": {
"type": "object",
"required": [
"question",
"keywords",
"brandAliases",
"engines",
"frequency"
],
"properties": {
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1
},
"topicId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"category": {
"anyOf": [
{
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 25
},
"question": {
"type": "string",
"maxLength": 1000,
"minLength": 10
},
"frequency": {
"enum": [
"manual",
"daily",
"weekly"
],
"type": "string"
},
"volumeTier": {
"anyOf": [
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
{
"type": "null"
}
]
},
"brandAliases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 2
},
"maxItems": 20,
"minItems": 1
}
}
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Create a topic to group prompts.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}After user review and approval, create one idempotent submission job in waiting_human state. This does not click the third-party site's final submit button.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| sourceId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId",
"siteId",
"sourceId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 120,
"minLength": 8
}
}
}Add a contact by hand.
| Argument | Type | Description |
|---|---|---|
| role* | string | |
| email* | string | |
| siteId* | string | |
| source | string | |
| company | string | |
| fullName* | string | |
| projectId* | string | |
| sourceUrl | string | |
| prospectId* | string | |
| roleCategory* | string | |
| sourceProvider | string | |
Create a draft campaign that turns a page into scheduled social posts.
| Argument | Type | Description |
|---|---|---|
| mode* | string | |
| name* | string | |
| endsAt* | any | |
| siteId* | string | |
| cadence* | object | |
| pageUrl* | string | |
| startsAt* | string | |
| projectId* | string | |
| accountIds* | array | |
| maxPostsPerAccount* | any | |
Create a rule that notifies a channel when matching leads arrive.
| Argument | Type | Description |
|---|---|---|
| rule* | object | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"rule"
],
"properties": {
"rule": {
"type": "object",
"required": [
"trigger",
"channel"
],
"properties": {
"channel": {
"enum": [
"email",
"webhook",
"slack",
"discord"
],
"type": "string"
},
"trigger": {
"enum": [
"hot_lead",
"competitor_lead",
"daily_digest",
"lead_stage_changed",
"brand_negative",
"brand_spike",
"brand_weekly"
],
"type": "string"
},
"webhookUrl": {
"type": "string",
"maxLength": 2000
},
"targetStage": {
"enum": [
"to_qualify",
"to_contact",
"in_conversation",
"closed"
],
"type": "string"
},
"recipientEmail": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 320
}
}
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add a customer profile that leads are scored against.
| Argument | Type | Description |
|---|---|---|
| icp* | object | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"icp"
],
"properties": {
"icp": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"roles": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"exclusions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"industries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"painPoints": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"description": {
"type": "string",
"default": "",
"maxLength": 1000
},
"intentPhrases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 20
}
}
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add a keyword to monitor, with its search phrases and platforms.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| keyword* | object | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"keyword"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"keyword": {
"type": "object",
"required": [
"name",
"type",
"queries"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"type": {
"enum": [
"buyer_intent",
"tool",
"competitor",
"topic",
"brand"
],
"type": "string"
},
"queries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 2
},
"maxItems": 3,
"minItems": 1
},
"platforms": {
"type": "array",
"items": {
"enum": [
"reddit",
"x",
"linkedin",
"tiktok",
"youtube",
"instagram",
"threads",
"facebook",
"hackernews",
"bluesky"
],
"type": "string"
},
"minItems": 1
},
"negativeKeywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
}
}
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Write a first email to a prospect's contact from a template and sender. Nothing is sent.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| contactId* | string | |
| projectId* | string | |
| prospectId* | string | |
| templateId* | string | |
| generationMode | string | |
| senderIdentityId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId",
"contactId",
"senderIdentityId",
"templateId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"contactId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"prospectId": {
"type": "string",
"minLength": 1
},
"templateId": {
"type": "string",
"minLength": 1
},
"generationMode": {
"enum": [
"template",
"ai"
],
"type": "string",
"default": "ai"
},
"senderIdentityId": {
"type": "string",
"minLength": 1
}
}
}Create an email template.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| siteId* | string | |
| projectId* | string | |
| bodyTemplate* | string | |
| fallbackValues | object | |
| subjectTemplate* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"name",
"subjectTemplate",
"bodyTemplate"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"bodyTemplate": {
"type": "string",
"maxLength": 10000,
"minLength": 20
},
"fallbackValues": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 300
}
},
"subjectTemplate": {
"type": "string",
"maxLength": 300,
"minLength": 3
}
}
}Add a product to the catalog. Pass imageStorageKey as null.
| Argument | Type | Description |
|---|---|---|
| fields* | object | |
| siteId* | string | |
| projectId* | string | |
| imageStorageKey* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"fields",
"imageStorageKey"
],
"properties": {
"fields": {
"type": "object",
"required": [
"title",
"url",
"description",
"price",
"currency"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2000
},
"price": {
"type": "string",
"maxLength": 30
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"currency": {
"type": "string",
"maxLength": 3
},
"description": {
"type": "string",
"maxLength": 2000
}
}
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"imageStorageKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}Approve or reject an article that is waiting for approval.
| Argument | Type | Description |
|---|---|---|
| reason | string | |
| siteId* | string | |
| assetId* | string | |
| decision* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId",
"decision"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000
},
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"decision": {
"enum": [
"approved",
"rejected"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Approve or reject an improvement that is waiting for approval.
| Argument | Type | Description |
|---|---|---|
| reason | string | |
| siteId* | string | |
| decision* | string | |
| projectId* | string | |
| improvementId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId",
"decision"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000
},
"siteId": {
"type": "string",
"minLength": 1
},
"decision": {
"enum": [
"approved",
"rejected"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
}
}
}Approve or reject one article brief in a content plan.
| Argument | Type | Description |
|---|---|---|
| planId* | string | |
| reason | string | |
| siteId* | string | |
| briefId* | string | |
| decision* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"planId",
"briefId",
"decision"
],
"properties": {
"planId": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"maxLength": 1000
},
"siteId": {
"type": "string",
"minLength": 1
},
"briefId": {
"type": "string",
"minLength": 1
},
"decision": {
"enum": [
"approved",
"rejected"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Approve or reject a whole content plan.
| Argument | Type | Description |
|---|---|---|
| planId* | string | |
| reason | string | |
| siteId* | string | |
| decision* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"planId",
"decision"
],
"properties": {
"planId": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"maxLength": 1000
},
"siteId": {
"type": "string",
"minLength": 1
},
"decision": {
"enum": [
"approved",
"rejected"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete a tracked prompt and its history.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| monitorId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitorId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete a topic. Its prompts are kept.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| topicId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"topicId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"topicId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete an article from Ranklybee. This does not remove a page already published on the website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| assetId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete an alert rule.
| Argument | Type | Description |
|---|---|---|
| ruleId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"ruleId"
],
"properties": {
"ruleId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete a customer profile.
| Argument | Type | Description |
|---|---|---|
| icpId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"icpId"
],
"properties": {
"icpId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete a monitoring keyword.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| keywordId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"keywordId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"keywordId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Delete an email template.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| templateId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"templateId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"templateId": {
"type": "string",
"minLength": 1
}
}
}Delete a product from the catalog.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| productId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"productId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"productId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Scan published articles against search data for new refresh opportunities.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Dismiss an improvement opportunity with a reason.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| siteId* | string | |
| projectId* | string | |
| improvementId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
}
}
}Hide a lead that is not relevant.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| mentionId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"mentionId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"mentionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Replace a post's text and approve it for publishing.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| postId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"postId",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 5000,
"minLength": 1
},
"postId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Leave a brand out of competitor comparisons.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Look up who to email at a prospect's site. Uses the plan's contact allowance.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| prospectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"prospectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Write the article for an approved brief. Uses the plan's article allowance and takes a few minutes; poll get_article.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| briefId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"briefId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"briefId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Write the improved version of an article for one opportunity.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| improvementId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Generate a new content plan from the site profile and keyword research. Uses the plan's content allowance.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Draft a reply to a lead's post in the chosen tone. Nothing is posted; the user posts it themselves.
| Argument | Type | Description |
|---|---|---|
| tone | string | |
| siteId* | string | |
| mentionId* | string | |
| projectId* | string | |
| regenerate | boolean | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"mentionId",
"idempotencyKey"
],
"properties": {
"tone": {
"enum": [
"peer",
"expert",
"founder"
],
"type": "string",
"default": "peer"
},
"siteId": {
"type": "string",
"minLength": 1
},
"mentionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"regenerate": {
"type": "boolean",
"default": false
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Read the full text of one recorded AI answer.
| Argument | Type | Description |
|---|---|---|
| runId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"runId"
],
"properties": {
"runId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Compare how favorably AI answers describe the brand and its rivals.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| rival | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"rival": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read one sentiment theme with quotes and suggested tasks; the summary and tasks are written on first read. themeKey comes from get_ai_sentiment_overview.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| themeKey* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"themeKey"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"themeKey": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read how positively AI answers describe the brand and the themes driving it.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read which domains and pages AI answers cite, and the domains that never mention the brand.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| category | string | |
| monitorId | string | |
| projectId* | string | |
| categories | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"category": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"categories": {
"type": "array",
"items": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"maxItems": 3
}
}
}Read one brand's visibility against the user's, with the prompts and sources behind it. brandKey comes from get_ai_visibility_competitors.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| brandKey* | string | |
| category | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"brandKey"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"brandKey": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"category": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the ranking of brands in AI answers, share of voice, and head-to-head prompts.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| compare | array | |
| engines | array | |
| category | string | |
| sovScope | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"compare": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 5
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"category": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"sovScope": {
"enum": [
"tracked",
"market"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the pages of one domain that AI answers cite.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| domain* | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| category | string | |
| monitorId | string | |
| projectId* | string | |
| categories | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"domain"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"domain": {
"type": "string",
"maxLength": 253,
"minLength": 1
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"category": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"categories": {
"type": "array",
"items": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"maxItems": 3
}
}
}Read how often AI assistants mention the brand: visibility, share of voice, position, and trend.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| siteId* | string | |
| engines | array | |
| projectId* | string | |
| categories | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"projectId": {
"type": "string",
"minLength": 1
},
"categories": {
"type": "array",
"items": {
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
"maxItems": 3
}
}
}Read one article with its full content, quality checks, and publication state.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| assetId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the refresh opportunities found for published articles and the state of each improvement.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the writing preferences for a website: voice, structure, images, linking, and improvement rules.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read whether the website's existing backlinks have been imported.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the current state and recorded outcome of a backlink submission job.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId",
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the current active Site's backlink submission profile and readiness state.
| Argument | Type | Description |
|---|---|---|
| siteId | string | |
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read totals for tracked backlinks, their health, and open replacement tasks.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read how often and where the brand is mentioned.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the automatic writing and publishing schedule for a website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the latest content plan for a website with its scheduled article briefs. Returns null when no plan exists.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read one campaign with its schedule and posts.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| campaignId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"campaignId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"campaignId": {
"type": "string",
"minLength": 1
}
}
}Read the talking points extracted from a page for social posts.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| pageUrl* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"pageUrl"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"pageUrl": {
"type": "string",
"format": "uri"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read whether social distribution is connected and which accounts post.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read one lead with its score, evidence quote, reason, stage, and link.
| Argument | Type | Description |
|---|---|---|
| leadId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId",
"leadId"
],
"properties": {
"leadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read lead counts by tier and stage, the monitor state, keywords, and customer profiles.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read what the outreach agent did over the last 7, 30, or 90 days.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read whether the outreach agent is running and its limits.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the sender identities and templates a new draft can use.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read scheduled and sent emails, sender limits, and replies waiting for review.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read how much of each plan allowance the Project has used in the current period.
| Argument | Type | Description |
|---|---|---|
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the progress and result counts of a discovery job.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read the Domain Rating range and page types used to find prospects.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read prospect counts by status for a website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read Google Search Console clicks, impressions, top queries and pages, and whether the property is connected.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read one traffic drop diagnosis with its findings.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| diagnosisId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"diagnosisId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"diagnosisId": {
"type": "string",
"minLength": 1
}
}
}Read the latest search health report and open alerts for a website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Read what Ranklybee knows about a website: positioning, audience, products, competitors, and the latest analysis job.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Save keywords to the website's keyword list without scheduling articles for them.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| phrases* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"phrases"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"phrases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"maxItems": 100,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the recorded answers for one prompt across AI engines.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| monitorId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitorId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the tracked prompts with visibility, position, and the brands each answer names.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| engine | string | |
| siteId* | string | |
| engines | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time"
},
"from": {
"type": "string",
"format": "date-time"
},
"engine": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 10
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the keywords saved for a website's articles.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List a website's articles, newest first, with their state and publication. Each item is large, so pass a small limit such as 10 and page with offset.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer | |
| search | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"search": {
"type": "string",
"default": "",
"maxLength": 200
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the signed-in user's Projects and their active Site details so the user can choose a target without knowing an internal Project ID.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List visible, available backlink sources that have a supported submission destination.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| limit | integer | |
| search | string | |
| projectId* | string | |
| sourceType | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 10000,
"minimum": 1
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1
},
"search": {
"type": "string",
"maxLength": 200
},
"projectId": {
"type": "string",
"minLength": 1
},
"sourceType": {
"enum": [
"directory",
"blog",
"guest_post",
"editorial",
"resource_page",
"community",
"tool",
"launch_platform",
"partner",
"other"
],
"type": "string"
}
}
}List the backlinks Ranklybee tracks for a website, with status and latest check.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| search | string | |
| siteId* | string | |
| sortBy | string | |
| perPage | integer | |
| dofollow | string | |
| statuses | array | |
| projectId* | string | |
| sortOrder | string | |
| categories | array | |
| pricingModes | array | |
List the CMS connections an article can be published to.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the people found for outreach, with email verification status.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| search | string | |
| siteId* | string | |
| sortBy | string | |
| perPage | integer | |
| statuses | array | |
| projectId* | string | |
| sortOrder | string | |
| verificationStatuses | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": 1
},
"search": {
"type": "string",
"maxLength": 200
},
"siteId": {
"type": "string",
"minLength": 1
},
"sortBy": {
"enum": [
"fullName",
"verificationStatus",
"createdAt"
],
"type": "string",
"default": "createdAt"
},
"perPage": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"statuses": {
"type": "array",
"items": {
"enum": [
"active",
"suppressed",
"invalid"
],
"type": "string"
},
"default": []
},
"projectId": {
"type": "string",
"minLength": 1
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc"
},
"verificationStatuses": {
"type": "array",
"items": {
"enum": [
"unverified",
"valid",
"risky",
"invalid"
],
"type": "string"
},
"default": []
}
}
}List pages that rank but get fewer clicks than expected.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the social distribution campaigns of a website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the website pages that can be turned into social posts.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List social posts by campaign, status, or platform.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| platform | string | |
| statuses | array | |
| projectId* | string | |
| campaignId | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"platform": {
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"enum": [
"pending_review",
"approved",
"submitted",
"scheduled",
"publishing",
"published",
"failed",
"blocked",
"cancelled",
"rejected"
],
"type": "string"
}
},
"projectId": {
"type": "string",
"minLength": 1
},
"campaignId": {
"type": "string"
}
}
}Search Ranklybee's library of directories and other backlink sources, with quality, pricing, and link type.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| view | string | |
| search | string | |
| siteId* | string | |
| sortBy | string | |
| perPage | integer | |
| linkTypes | array | |
| projectId* | string | |
| sortOrder | string | |
| sourceType | string | |
| pricingModels | array |
List the pages articles are allowed to link to.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the rules that notify the user about new leads.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the monitoring keywords (search phrases and platforms) for a Project.
| Argument | Type | Description |
|---|---|---|
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"minLength": 1
}
}
}List scored leads for a Project, newest first. Filter by tier (hot, warm, explore), stage, platform, or text. Each lead has the evidence quote that shows the buying intent and a link to the original post.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| limit | integer | |
| siteId | string | |
| filters | object | |
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 10000,
"minimum": 1
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"filters": {
"type": "object",
"properties": {
"tier": {
"enum": [
"hot",
"warm",
"explore"
],
"type": "string"
},
"view": {
"enum": [
"quality",
"all",
"archived"
],
"type": "string",
"default": "quality"
},
"icpId": {
"type": "string",
"minLength": 1
},
"stage": {
"enum": [
"to_qualify",
"to_contact",
"in_conversation",
"closed"
],
"type": "string"
},
"search": {
"type": "string",
"maxLength": 100
},
"leadType": {
"enum": [
"competitor",
"describes_problem",
"looking_for_solution",
"other"
],
"type": "string"
},
"platform": {
"enum": [
"reddit",
"x",
"linkedin",
"tiktok",
"youtube",
"instagram",
"threads",
"facebook",
"hackernews",
"bluesky"
],
"type": "string"
},
"keywordId": {
"type": "string",
"minLength": 1
}
}
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the pages the user pitches in outreach.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List collected posts that matched a keyword, including brand mentions that are not leads.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| sort | string | |
| dateTo | string | |
| orders | array | |
| search | string | |
| siteId* | string | |
| purpose | string | |
| sources | array | |
| dateFrom | string | |
| pageSize | integer | |
| platform | string | |
| scoreMax |
List the cases the outreach agent stopped on and left for a human.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| statuses | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"statuses": {
"type": "array",
"items": {
"enum": [
"open",
"in_progress",
"retrying",
"resolved",
"dismissed"
],
"type": "string"
},
"default": []
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List recent runs of the outreach agent.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the keywords used to search for link prospects.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the email templates available for outreach.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List outreach threads in one bucket (ready, queued, sent, or replied) with their draft and latest message.
| Argument | Type | Description |
|---|---|---|
| bucket | string | |
| search | string | |
| siteId* | string | |
| projectId* | string | |
| starredOnly | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"bucket": {
"enum": [
"ready",
"queued",
"sent",
"replied"
],
"type": "string",
"default": "ready"
},
"search": {
"type": "string",
"maxLength": 200
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"starredOnly": {
"type": "boolean",
"default": false
}
}
}List the products articles can feature.
| Argument | Type | Description |
|---|---|---|
| query | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"query": {
"type": "string",
"maxLength": 100
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the signed-in user's Projects with their role and websites. Start here to get a projectId.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List link prospects with scores, status, and contact. Filter by status, keyword, or Domain Rating.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| search | string | |
| siteId* | string | |
| sortBy | string | |
| contact | string | |
| keyword | string | |
| perPage | integer | |
| pageType | string | |
| statuses | array | |
| projectId* | string | |
| sortOrder | string | |
List the on-page changes logged for a website and their measured effect.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the traffic drop diagnoses run for a website.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}List the websites in a Project. Most tools need a siteId from this list.
| Argument | Type | Description |
|---|---|---|
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"minLength": 1
}
}
}Record a change made to a page so its effect on search performance is measured.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| note | any | |
| after | any | |
| before | any | |
| siteId* | string | |
| pageUrl* | string | |
| changedAt | string | |
| projectId* | string | |
| confirmStacked | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"pageUrl",
"kind"
],
"properties": {
"kind": {
"enum": [
"title",
"meta",
"content",
"technical",
"links",
"publish",
"other"
],
"type": "string"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"after": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"before": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"siteId": {
"type": "string",
"minLength": 1
},
"pageUrl": {
"type": "string",
"format": "uri"
},
"changedAt": {
"type": "string",
"format": "date-time"
},
"projectId": {
"type": "string",
"minLength": 1
},
"confirmStacked": {
"type": "boolean"
}
}
}Close an outreach thread that did not earn a link.
| Argument | Type | Description |
|---|---|---|
| reason | string | |
| siteId* | string | |
| threadId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500
},
"siteId": {
"type": "string",
"minLength": 1
},
"threadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Record that the outreach earned a link and start tracking that backlink.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| threadId* | string | |
| projectId* | string | |
| sourceUrl* | string | |
| targetUrl* | string | |
| expectedAnchor | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId",
"sourceUrl",
"targetUrl"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"threadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"targetUrl": {
"type": "string",
"format": "uri"
},
"expectedAnchor": {
"type": "string",
"maxLength": 500
}
}
}Move prompts into a topic, or pass topicId null to ungroup them.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| topicId* | any | |
| projectId* | string | |
| monitorIds* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitorIds",
"topicId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"topicId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"projectId": {
"type": "string",
"minLength": 1
},
"monitorIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 200,
"minItems": 1
}
}
}Move a lead to to_qualify, to_contact, in_conversation, or closed. This fires any stage-changed automations the user configured.
| Argument | Type | Description |
|---|---|---|
| stage* | string | |
| leadId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId",
"leadId",
"stage"
],
"properties": {
"stage": {
"enum": [
"to_qualify",
"to_contact",
"in_conversation",
"closed"
],
"type": "string"
},
"leadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Pause a running campaign.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| campaignId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"campaignId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"campaignId": {
"type": "string",
"minLength": 1
}
}
}Check paid access, profile confirmation, source policy, inventory, duplicate backlinks, and daily capacity before creating a submission job.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| sourceId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId",
"siteId",
"sourceId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Write a first email to a prospect's contact, letting Ranklybee pick the sender and template. Nothing is sent.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| contactId* | string | |
| projectId* | string | |
| prospectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId",
"contactId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"contactId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"prospectId": {
"type": "string",
"minLength": 1
}
}
}Publish an approved article to a connected CMS. The article goes live on the user's website, so confirm with the user first.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| assetId* | string | |
| projectId* | string | |
| connectionId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId",
"connectionId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"connectionId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Record the result after a user-approved browser interaction. Use needs_verification for CAPTCHA, MFA, email verification, rate limits, or ambiguous results.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| status* | string | |
| message | any | |
| projectId* | string | |
| externalUrl | any | |
| externalReference | any |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"projectId",
"jobId",
"status"
],
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"submitted",
"pending_review",
"needs_verification",
"failed"
],
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"default": null
},
"projectId": {
"type": "string",
"minLength": 1
},
"externalUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
],
"default": null
},
"externalReference": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"default": null
}
}
}Rewrite the chosen fields of an article with AI.
| Argument | Type | Description |
|---|---|---|
| fields* | array | |
| siteId* | string | |
| assetId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId",
"fields",
"idempotencyKey"
],
"properties": {
"fields": {
"type": "array",
"items": {
"enum": [
"full",
"title",
"excerpt",
"body",
"meta"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Write a post again with AI.
| Argument | Type | Description |
|---|---|---|
| postId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"postId"
],
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Rewrite an unsent draft following an instruction.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| threadId* | string | |
| projectId* | string | |
| instruction* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId",
"instruction"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"threadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"instruction": {
"type": "string",
"maxLength": 500,
"minLength": 3
}
}
}Reject posts so they are not published.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| postIds* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"postIds"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"postIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 200,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Reject one prospect, or block its whole domain from future discovery (a reason is required to block).
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| decision* | any | |
| projectId* | string | |
| prospectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId",
"decision"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"decision": {
"oneOf": [
{
"type": "object",
"required": [
"status"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"status": {
"type": "string",
"const": "rejected"
}
}
},
{
"type": "object",
"required": [
"status",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"status": {
"type": "string",
"const": "blocked"
}
}
}
]
},
"projectId": {
"type": "string",
"minLength": 1
},
"prospectId": {
"type": "string",
"minLength": 1
}
}
}Remove keywords from the website's saved keyword list.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| phrases* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"phrases"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"phrases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 200,
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Stop articles from linking to a page.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Remove one prospecting keyword.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| keywordId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"keywordId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"keywordId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Rename a prompt topic.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| siteId* | string | |
| topicId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"topicId",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"topicId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Reopen a thread that was marked won or lost.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| threadId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"threadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Move an article brief to another date (YYYY-MM-DD) on the content calendar.
| Argument | Type | Description |
|---|---|---|
| planId* | string | |
| siteId* | string | |
| briefId* | string | |
| projectId* | string | |
| scheduledDate* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"planId",
"briefId",
"scheduledDate"
],
"properties": {
"planId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"briefId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"scheduledDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
}
}
}Bring an excluded brand back into competitor comparisons.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| normalizedName* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"normalizedName"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"normalizedName": {
"type": "string",
"maxLength": 120,
"minLength": 1
}
}
}Bring back a dismissed lead.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| mentionId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"mentionId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"mentionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Resume a paused campaign.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| campaignId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"campaignId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"campaignId": {
"type": "string",
"minLength": 1
}
}
}Act on a reply Ranklybee drafted for an inbound email. action=send emails a real person; get the user's approval first.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| action* | string | |
| siteId* | string | |
| projectId* | string | |
| suggestionId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"suggestionId",
"action",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 5000,
"minLength": 10
},
"action": {
"enum": [
"send",
"retry_confirmed_unsent",
"dismiss"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"suggestionId": {
"type": "string",
"minLength": 1
}
}
}Fetch a page and review its title and meta description against the queries it ranks for.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| pageUrl* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"pageUrl"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"pageUrl": {
"type": "string",
"format": "uri"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Ask the AI engines one tracked prompt now and record the answers.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| monitorId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitorId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Search the monitored platforms now and score what is found. Uses the plan's lead scan allowance.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add or update a page worth pitching, with what makes it link-worthy.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| type* | string | |
| title* | string | |
| siteId* | string | |
| summary* | string | |
| projectId* | string | |
| uniqueValue* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"url",
"title",
"type",
"summary",
"uniqueValue"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"type": {
"enum": [
"product",
"research",
"statistics",
"template",
"guide",
"free_tool",
"case_study"
],
"type": "string"
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 2
},
"siteId": {
"type": "string",
"minLength": 1
},
"summary": {
"type": "string",
"maxLength": 2000,
"minLength": 30
},
"projectId": {
"type": "string",
"minLength": 1
},
"uniqueValue": {
"type": "string",
"maxLength": 2000,
"minLength": 20
}
}
}Schedule a drafted thread with up to two follow-ups. mode=live emails a real person from the user's mailbox; show the user the exact email and get approval first. mode=simulation sends nothing.
| Argument | Type | Description |
|---|---|---|
| mode* | string | |
| siteId* | string | |
| sendNow | boolean | |
| threadId* | string | |
| followUps | array | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId",
"mode",
"idempotencyKey"
],
"properties": {
"mode": {
"enum": [
"simulation",
"live"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"sendNow": {
"type": "boolean",
"default": false
},
"threadId": {
"type": "string",
"minLength": 1
},
"followUps": {
"type": "array",
"items": {
"type": "object",
"required": [
"delayDays",
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 10000,
"minLength": 20
},
"subject": {
"type": "string",
"maxLength": 300,
"minLength": 3
},
"delayDays": {
"type": "integer",
"maximum": 30,
"minimum": 1
}
}
},
"default": [],
"maxItems": 2
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Schedule several drafted threads at once. mode=live emails real people; get the user's approval of every email first.
| Argument | Type | Description |
|---|---|---|
| mode* | string | |
| siteId* | string | |
| followUps | array | |
| projectId* | string | |
| threadIds* | array | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadIds",
"mode",
"idempotencyKey"
],
"properties": {
"mode": {
"enum": [
"simulation",
"live"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"followUps": {
"type": "array",
"items": {
"type": "object",
"required": [
"delayDays",
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 10000,
"minLength": 20
},
"subject": {
"type": "string",
"maxLength": 300,
"minLength": 3
},
"delayDays": {
"type": "integer",
"maximum": 30,
"minimum": 1
}
}
},
"default": [],
"maxItems": 2
},
"projectId": {
"type": "string",
"minLength": 1
},
"threadIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 100,
"minItems": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Look up keyword ideas for a seed phrase with volume, difficulty, and whether each is already in the plan. The ideas are saved to the website's keyword list.
| Argument | Type | Description |
|---|---|---|
| query* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"query"
],
"properties": {
"query": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Set which email address outreach to a prospect goes to.
| Argument | Type | Description |
|---|---|---|
| email* | string | |
| siteId* | string | |
| projectId* | string | |
| prospectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId",
"email",
"idempotencyKey"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"prospectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Send a message in an existing outreach thread from the user's mailbox. Get the user's approval of the exact text first.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| siteId* | string | |
| ccEmails | array | |
| threadId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId",
"body",
"idempotencyKey"
],
"properties": {
"body": {
"type": "string",
"maxLength": 10000,
"minLength": 10
},
"siteId": {
"type": "string",
"minLength": 1
},
"ccEmails": {
"type": "array",
"items": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"default": [],
"maxItems": 10
},
"threadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Mark a suggested sentiment task as done or not done.
| Argument | Type | Description |
|---|---|---|
| done* | boolean | |
| siteId* | string | |
| taskId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"taskId",
"done"
],
"properties": {
"done": {
"type": "boolean"
},
"siteId": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Pause or resume tracking for one prompt.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| monitorId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitorId",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string"
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Pause or resume one alert rule.
| Argument | Type | Description |
|---|---|---|
| ruleId* | string | |
| siteId* | string | |
| status* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"ruleId",
"status"
],
"properties": {
"ruleId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Add or remove a lead from the user's favorites.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| favorite* | boolean | |
| mentionId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"mentionId",
"favorite"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"favorite": {
"type": "boolean"
},
"mentionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Tell Ranklybee whether a lead was a good match so scoring improves.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| feedback* | string | |
| mentionId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"mentionId",
"feedback"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"feedback": {
"enum": [
"up",
"down"
],
"type": "string"
},
"mentionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Pause or resume monitoring for one keyword.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| keywordId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"keywordId",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string"
},
"keywordId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Pause or resume the outreach agent. While active it finds prospects and sends emails on its own.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Set whether articles may feature a product.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| productId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"productId",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"active",
"hidden"
],
"type": "string"
},
"productId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Import the website's existing backlinks so duplicates are detected.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Find prospects among the sites that link to the given competitor domains. Runs in the background.
| Argument | Type | Description |
|---|---|---|
| goal | string | |
| siteId* | string | |
| refresh | boolean | |
| projectId* | string | |
| competitorDomains* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"competitorDomains"
],
"properties": {
"goal": {
"enum": [
"all",
"editorial_outreach",
"paid_placements"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"refresh": {
"type": "boolean",
"default": false
},
"projectId": {
"type": "string",
"minLength": 1
},
"competitorDomains": {
"type": "array",
"items": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"maxItems": 8,
"minItems": 1
}
}
}Search the web for link prospects. Runs in the background; poll get_prospect_discovery with the returned job. Uses the plan's prospecting allowance.
| Argument | Type | Description |
|---|---|---|
| goal | string | |
| siteId* | string | |
| refresh | boolean | |
| projectId* | string | |
| selectedKeywords | array | |
| confirmedKeywords | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"goal": {
"enum": [
"all",
"editorial_outreach",
"paid_placements"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"refresh": {
"type": "boolean",
"default": false
},
"projectId": {
"type": "string",
"minLength": 1
},
"selectedKeywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 10,
"minItems": 1
},
"confirmedKeywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 2,
"minItems": 2
}
}
}Analyze a year of search data for the cause of a traffic drop, optionally for a date range (YYYY-MM-DD).
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| rangeEnd | string | |
| projectId* | string | |
| rangeStart | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"rangeEnd": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"projectId": {
"type": "string",
"minLength": 1
},
"rangeStart": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
}Cancel the remaining emails of a scheduled sequence.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| siteId* | string | |
| projectId* | string | |
| sequenceId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"sequenceId",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"sequenceId": {
"type": "string",
"minLength": 1
}
}
}Send a draft article to the approval step.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| assetId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Send a drafted improvement to the approval step.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| improvementId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
}
}
}Ask AI for prompts worth tracking for the website. Nothing is tracked until you create them.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| description | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 1000
}
}
}Add a contact to the do-not-email list with a reason.
| Argument | Type | Description |
|---|---|---|
| scope* | string | |
| reason* | string | |
| siteId* | string | |
| source | string | |
| contactId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"contactId",
"scope",
"reason"
],
"properties": {
"scope": {
"enum": [
"project",
"global"
],
"type": "string"
},
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"siteId": {
"type": "string",
"minLength": 1
},
"source": {
"enum": [
"manual",
"unsubscribe",
"bounce",
"complaint",
"platform_policy"
],
"type": "string",
"default": "manual"
},
"contactId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Pull the latest data from Google Search Console.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"idempotencyKey"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Allow a previously blocked domain to appear in discovery again.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| projectId* | string | |
| prospectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"prospectId": {
"type": "string",
"minLength": 1
}
}
}Replace a tracked prompt's settings.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| monitor* | object | |
| monitorId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"monitorId",
"monitor"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"monitor": {
"type": "object",
"required": [
"question",
"keywords",
"brandAliases",
"engines",
"frequency"
],
"properties": {
"engines": {
"type": "array",
"items": {
"enum": [
"google_ai_mode",
"chatgpt",
"gemini",
"perplexity",
"grok",
"copilot",
"claude"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1
},
"topicId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"category": {
"anyOf": [
{
"enum": [
"commercial",
"competitor",
"branded"
],
"type": "string"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 25
},
"question": {
"type": "string",
"maxLength": 1000,
"minLength": 10
},
"frequency": {
"enum": [
"manual",
"daily",
"weekly"
],
"type": "string"
},
"volumeTier": {
"anyOf": [
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
{
"type": "null"
}
]
},
"brandAliases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 2
},
"maxItems": 20,
"minItems": 1
}
}
},
"monitorId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Replace an article's editable content. Read it with get_article first and send every content field back.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| assetId* | string | |
| content* | object | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId",
"content"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"content": {
"type": "object",
"required": [
"title",
"slug",
"excerpt",
"body",
"metaTitle",
"metaDescription",
"heroImageUrl",
"heroImageStorageKey",
"tags"
],
"properties": {
"body": {
"type": "string",
"maxLength": 100000,
"minLength": 100
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 120,
"minLength": 2
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 5
},
"excerpt": {
"type": "string",
"maxLength": 500,
"minLength": 20
},
"metaTitle": {
"type": "string",
"maxLength": 70,
"minLength": 5
},
"heroImageUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"metaDescription": {
"type": "string",
"maxLength": 180,
"minLength": 20
},
"heroImageStorageKey": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
}
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Replace the drafted content of an improvement. Send every content field back.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| content* | object | |
| projectId* | string | |
| improvementId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"improvementId",
"content"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"content": {
"type": "object",
"required": [
"title",
"slug",
"excerpt",
"body",
"metaTitle",
"metaDescription",
"heroImageUrl",
"changeSummary"
],
"properties": {
"body": {
"type": "string",
"maxLength": 100000,
"minLength": 100
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 120,
"minLength": 2
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 5
},
"excerpt": {
"type": "string",
"maxLength": 500,
"minLength": 20
},
"metaTitle": {
"type": "string",
"maxLength": 70,
"minLength": 5
},
"heroImageUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"changeSummary": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 5
},
"maxItems": 10,
"minItems": 1
},
"metaDescription": {
"type": "string",
"maxLength": 180,
"minLength": 20
}
}
},
"projectId": {
"type": "string",
"minLength": 1
},
"improvementId": {
"type": "string",
"minLength": 1
}
}
}Change the status or notes of a task opened for a lost backlink.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| taskId* | string | |
| projectId* | string | |
| assigneeUserId | string | |
| resolutionNotes | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"taskId",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"open",
"in_progress",
"resolved",
"dismissed"
],
"type": "string"
},
"taskId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"assigneeUserId": {
"type": "string"
},
"resolutionNotes": {
"type": "string",
"maxLength": 2000
}
}
}Replace the automatic writing and publishing schedule. Read it with get_content_automation first; auto_publish_approved publishes without a human review.
| Argument | Type | Description |
|---|---|---|
| mode* | string | |
| siteId* | string | |
| enabled* | boolean | |
| timezone* | string | |
| projectId* | string | |
| publishTime* | string | |
| publishingDays* | array | |
| generationLeadHours* | integer | |
| defaultCmsConnectionId* | any |
Set the notes the writer follows for one article brief. Send an empty string to clear them.
| Argument | Type | Description |
|---|---|---|
| planId* | string | |
| siteId* | string | |
| briefId* | string | |
| projectId* | string | |
| instructions* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"planId",
"briefId",
"instructions"
],
"properties": {
"planId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"briefId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"instructions": {
"type": "string",
"maxLength": 2000
}
}
}Change the target keyword of one article brief.
| Argument | Type | Description |
|---|---|---|
| phrase* | string | |
| planId* | string | |
| siteId* | string | |
| briefId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"planId",
"briefId",
"phrase"
],
"properties": {
"phrase": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"planId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"briefId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Replace a draft campaign's settings.
| Argument | Type | Description |
|---|---|---|
| mode* | string | |
| name* | string | |
| endsAt* | any | |
| siteId* | string | |
| cadence* | object | |
| pageUrl* | string | |
| startsAt* | string | |
| projectId* | string | |
| accountIds* | array | |
| campaignId* | string | |
| maxPostsPerAccount |
Replace a customer profile.
| Argument | Type | Description |
|---|---|---|
| icp* | object | |
| icpId* | string | |
| siteId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"icpId",
"icp"
],
"properties": {
"icp": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"roles": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"exclusions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"industries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"painPoints": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"description": {
"type": "string",
"default": "",
"maxLength": 1000
},
"intentPhrases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 20
}
}
},
"icpId": {
"type": "string",
"minLength": 1
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Replace a monitoring keyword's phrases and platforms.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| keyword* | object | |
| keywordId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"keywordId",
"keyword"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"keyword": {
"type": "object",
"required": [
"name",
"type",
"queries"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"type": {
"enum": [
"buyer_intent",
"tool",
"competitor",
"topic",
"brand"
],
"type": "string"
},
"queries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 2
},
"maxItems": 3,
"minItems": 1
},
"platforms": {
"type": "array",
"items": {
"enum": [
"reddit",
"x",
"linkedin",
"tiktok",
"youtube",
"instagram",
"threads",
"facebook",
"hackernews",
"bluesky"
],
"type": "string"
},
"minItems": 1
},
"negativeKeywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
}
}
},
"keywordId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Set how often leads are scanned and whether the monitor is active.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| frequency* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"frequency",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string"
},
"frequency": {
"enum": [
"manual",
"daily"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Edit a drafted reply, or record that the user posted or dismissed it.
| Argument | Type | Description |
|---|---|---|
| body | string | |
| action* | string | |
| siteId* | string | |
| mentionId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"mentionId",
"action"
],
"properties": {
"body": {
"type": "string",
"maxLength": 10000,
"minLength": 1
},
"action": {
"enum": [
"edit",
"posted",
"dismissed"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"mentionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Set which platforms are searched for leads.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| platforms* | array | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"platforms"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"platforms": {
"type": "array",
"items": {
"enum": [
"reddit",
"x",
"linkedin",
"tiktok",
"youtube",
"instagram",
"threads",
"facebook",
"hackernews",
"bluesky"
],
"type": "string"
},
"maxItems": 10
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Change the status or notes of an exception.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| projectId* | string | |
| exceptionId* | string | |
| assigneeUserId | any | |
| resolutionNotes | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"exceptionId",
"status"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"open",
"in_progress",
"retrying",
"resolved",
"dismissed"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
},
"exceptionId": {
"type": "string",
"minLength": 1
},
"assigneeUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resolutionNotes": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"default": null
}
}
}Replace the subject and body of an unsent draft.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| siteId* | string | |
| subject* | string | |
| threadId* | string | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"threadId",
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 10000,
"minLength": 20
},
"siteId": {
"type": "string",
"minLength": 1
},
"subject": {
"type": "string",
"maxLength": 300,
"minLength": 3
},
"threadId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Set the sending window, weekdays, and daily limit for one sender identity.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| status* | string | |
| projectId* | string | |
| dailyLimit* | integer | |
| allowedWeekdays* | array | |
| windowEndMinute* | integer | |
| senderIdentityId* | string | |
| windowStartMinute* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"senderIdentityId",
"status",
"windowStartMinute",
"windowEndMinute",
"allowedWeekdays",
"dailyLimit"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"status": {
"enum": [
"paused",
"active"
],
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
},
"dailyLimit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"allowedWeekdays": {
"type": "array",
"items": {
"type": "integer",
"maximum": 6,
"minimum": 0
},
"maxItems": 7,
"minItems": 1
},
"windowEndMinute": {
"type": "integer",
"maximum": 1440,
"minimum": 1
},
"senderIdentityId": {
"type": "string",
"minLength": 1
},
"windowStartMinute": {
"type": "integer",
"maximum": 1439,
"minimum": 0
}
}
}Replace an email template's content.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| siteId* | string | |
| projectId* | string | |
| templateId* | string | |
| bodyTemplate* | string | |
| fallbackValues | object | |
| subjectTemplate* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"templateId",
"name",
"subjectTemplate",
"bodyTemplate"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"siteId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"templateId": {
"type": "string",
"minLength": 1
},
"bodyTemplate": {
"type": "string",
"maxLength": 10000,
"minLength": 20
},
"fallbackValues": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 300
}
},
"subjectTemplate": {
"type": "string",
"maxLength": 300,
"minLength": 3
}
}
}Replace a product's fields. Send every field back.
| Argument | Type | Description |
|---|---|---|
| fields* | object | |
| siteId* | string | |
| productId* | string | |
| projectId* | string | |
| imageStorageKey | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"productId",
"fields"
],
"properties": {
"fields": {
"type": "object",
"required": [
"title",
"url",
"description",
"price",
"currency"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2000
},
"price": {
"type": "string",
"maxLength": 30
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"currency": {
"type": "string",
"maxLength": 3
},
"description": {
"type": "string",
"maxLength": 2000
}
}
},
"siteId": {
"type": "string",
"minLength": 1
},
"productId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"imageStorageKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}Replace the settings used to find prospects. Send every field.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| pageTypes* | array | |
| projectId* | string | |
| maxDomainRating* | integer | |
| minDomainRating* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"minDomainRating",
"maxDomainRating",
"pageTypes"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"pageTypes": {
"type": "array",
"items": {
"enum": [
"listicle",
"guide",
"comparison",
"review",
"news",
"tutorial",
"resource_page",
"other"
],
"type": "string"
},
"minItems": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"maxDomainRating": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"minDomainRating": {
"type": "integer",
"maximum": 100,
"minimum": 0
}
}
}Replace the editable site profile. Read it with get_site_profile first and send every field back, changing only what the user asked for.
| Argument | Type | Description |
|---|---|---|
| siteId* | string | |
| profile* | object | |
| projectId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"profile"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"profile": {
"type": "object",
"required": [
"productName",
"tagline",
"shortDescription",
"longDescription",
"features",
"useCases",
"categoryHints",
"niche",
"websiteDescription",
"targetAudience",
"brandVoice",
"valueProposition",
"publicContactName",
"publicContactEmail",
"socialLinks",
"pricingModel",
"launchDate",
"logoUrl",
"coverImageUrl",
"screenshotUrls",
"competitors",
"topics",
"approvedClaims"
],
"properties": {
"niche": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"topics": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"logoUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"tagline": {
"type": "string",
"maxLength": 200
},
"features": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20
},
"useCases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20
},
"brandVoice": {
"type": "string",
"maxLength": 500,
"minLength": 2
},
"launchDate": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
{
"type": "null"
}
]
},
"competitors": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"domain": {
"type": "string",
"maxLength": 160,
"minLength": 1
}
}
},
"maxItems": 30
},
"productName": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"socialLinks": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"format": "uri"
}
},
"pricingModel": {
"enum": [
"free",
"freemium",
"paid",
"contact"
],
"type": "string"
},
"categoryHints": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20
},
"coverImageUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"approvedClaims": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 30
},
"screenshotUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"maxItems": 10
},
"targetAudience": {
"type": "string",
"maxLength": 1000,
"minLength": 2
},
"longDescription": {
"type": "string",
"maxLength": 5000
},
"shortDescription": {
"type": "string",
"maxLength": 500
},
"valueProposition": {
"type": "string",
"maxLength": 2000,
"minLength": 2
},
"publicContactName": {
"type": "string",
"maxLength": 120
},
"publicContactEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "string",
"const": ""
}
]
},
"websiteDescription": {
"type": "string",
"maxLength": 2000,
"minLength": 2
}
}
},
"projectId": {
"type": "string",
"minLength": 1
}
}
}Record the live URL of an article the user published by hand, after checking the page.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| siteId* | string | |
| assetId* | string | |
| projectId* | string | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"assetId",
"url",
"idempotencyKey"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"siteId": {
"type": "string",
"minLength": 1
},
"assetId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
}
}
}Check whether a contact's email address is deliverable.
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| siteId* | string | |
| source* | string | |
| status* | string | |
| provider* | string | |
| contactId* | string | |
| projectId* | string | |
| costMicros* | integer | |
| idempotencyKey* | string | |
| providerReference | string |
| pricingSource |
| string |
| contentAssetId | string |
| expectedAnchor | string |
| priceAmountMinor | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"source",
"sourceUrl",
"targetUrl"
],
"properties": {
"siteId": {
"type": "string",
"minLength": 1
},
"source": {
"enum": [
"outreach",
"manual"
],
"type": "string"
},
"category": {
"enum": [
"editorial",
"directory",
"resource_page",
"listicle",
"comparison",
"launch_platform",
"partner",
"other"
],
"type": "string"
},
"threadId": {
"type": "string"
},
"projectId": {
"type": "string",
"minLength": 1
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"targetUrl": {
"type": "string",
"format": "uri"
},
"prospectId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"expectedRel": {
"type": "array",
"items": {
"enum": [
"nofollow",
"sponsored",
"ugc"
],
"type": "string"
},
"default": [],
"maxItems": 3
},
"pricingMode": {
"enum": [
"free",
"paid",
"unknown"
],
"type": "string",
"default": "unknown"
},
"priceCurrency": {
"type": "string",
"maxLength": 3,
"minLength": 3
},
"pricingSource": {
"enum": [
"featured_catalog",
"manual",
"unknown"
],
"type": "string",
"default": "manual"
},
"contentAssetId": {
"type": "string"
},
"expectedAnchor": {
"type": "string",
"maxLength": 500
},
"priceAmountMinor": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
}
}| sourceReference |
| string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"prospectId",
"email",
"fullName",
"role",
"roleCategory"
],
"properties": {
"role": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"siteId": {
"type": "string",
"minLength": 1
},
"source": {
"enum": [
"manual",
"provider",
"import"
],
"type": "string",
"default": "manual"
},
"company": {
"type": "string",
"maxLength": 160
},
"fullName": {
"type": "string",
"maxLength": 120,
"minLength": 2
},
"projectId": {
"type": "string",
"minLength": 1
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"prospectId": {
"type": "string",
"minLength": 1
},
"roleCategory": {
"enum": [
"editor",
"writer",
"marketing",
"founder",
"partnerships",
"other"
],
"type": "string"
},
"sourceProvider": {
"type": "string",
"maxLength": 100
},
"sourceReference": {
"type": "string",
"maxLength": 300
}
}
}| autoPublishAccountIds |
| array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"name",
"pageUrl",
"accountIds",
"cadence",
"startsAt",
"endsAt",
"maxPostsPerAccount",
"mode"
],
"properties": {
"mode": {
"enum": [
"review_required",
"auto_publish"
],
"type": "string"
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"siteId": {
"type": "string",
"minLength": 1
},
"cadence": {
"type": "object",
"required": [
"postsPerWeek",
"days",
"windowStart",
"windowEnd",
"timezone"
],
"properties": {
"days": {
"type": "array",
"items": {
"type": "integer",
"maximum": 6,
"minimum": 0
},
"maxItems": 7,
"minItems": 1
},
"timezone": {
"type": "string",
"minLength": 1
},
"windowEnd": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"windowStart": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"postsPerWeek": {
"type": "integer",
"maximum": 7,
"minimum": 1
}
}
},
"pageUrl": {
"type": "string",
"format": "uri"
},
"startsAt": {
"type": "string",
"format": "date-time"
},
"projectId": {
"type": "string",
"minLength": 1
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"minItems": 1
},
"maxPostsPerAccount": {
"anyOf": [
{
"type": "integer",
"maximum": 60,
"minimum": 1
},
{
"type": "null"
}
]
},
"autoPublishAccountIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": [],
"maxItems": 20
}
}
}| maximumTraffic |
| integer |
| minimumTraffic | integer |
| maximumDomainRating | integer |
| minimumDomainRating | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": 1
},
"search": {
"type": "string",
"maxLength": 300
},
"siteId": {
"type": "string",
"minLength": 1
},
"sortBy": {
"enum": [
"domainRating",
"traffic",
"status",
"firstSeenAt",
"lastCheckedAt"
],
"type": "string",
"default": "lastCheckedAt"
},
"perPage": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"dofollow": {
"enum": [
"all",
"yes",
"no",
"unknown"
],
"type": "string",
"default": "all"
},
"statuses": {
"type": "array",
"items": {
"enum": [
"pending",
"live",
"changed",
"lost",
"blocked",
"error",
"closed"
],
"type": "string"
},
"default": []
},
"projectId": {
"type": "string",
"minLength": 1
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc"
},
"categories": {
"type": "array",
"items": {
"enum": [
"editorial",
"directory",
"resource_page",
"listicle",
"comparison",
"launch_platform",
"partner",
"other"
],
"type": "string"
},
"default": []
},
"pricingModes": {
"type": "array",
"items": {
"enum": [
"free",
"paid",
"unknown"
],
"type": "string"
},
"default": []
},
"maximumTraffic": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"minimumTraffic": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"maximumDomainRating": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"minimumDomainRating": {
"type": "integer",
"maximum": 100,
"minimum": 0
}
}
}| accountRequirements | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": 1
},
"view": {
"enum": [
"available",
"recently_added",
"recently_removed"
],
"type": "string",
"default": "available"
},
"search": {
"type": "string",
"maxLength": 200
},
"siteId": {
"type": "string",
"minLength": 1
},
"sortBy": {
"enum": [
"name",
"qualityScore",
"domainRating",
"traffic"
],
"type": "string",
"default": "domainRating"
},
"perPage": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"linkTypes": {
"type": "array",
"items": {
"enum": [
"dofollow",
"nofollow",
"mixed",
"unknown"
],
"type": "string"
},
"default": []
},
"projectId": {
"type": "string",
"minLength": 1
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc"
},
"sourceType": {
"enum": [
"directory",
"blog",
"guest_post",
"editorial",
"resource_page",
"community",
"tool",
"launch_platform",
"partner",
"other"
],
"type": "string"
},
"pricingModels": {
"type": "array",
"items": {
"enum": [
"free",
"freemium",
"paid",
"unknown"
],
"type": "string"
},
"default": []
},
"accountRequirements": {
"type": "array",
"items": {
"enum": [
"required",
"not_required",
"unknown",
"not_applicable"
],
"type": "string"
},
"default": [],
"maxItems": 4
}
}
}| integer |
| scoreMin | integer |
| favorites | boolean |
| keywordId | string |
| projectId* | string |
| sentiment | string |
| upvotesMax | integer |
| upvotesMin | integer |
| commentsMax | integer |
| commentsMin | integer |
| needsResponse | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": 1
},
"sort": {
"enum": [
"recent",
"score"
],
"type": "string",
"default": "recent"
},
"dateTo": {
"type": "string",
"format": "date-time"
},
"orders": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"dir"
],
"properties": {
"dir": {
"enum": [
"asc",
"desc"
],
"type": "string"
},
"field": {
"enum": [
"date",
"comments",
"upvotes",
"traffic",
"score"
],
"type": "string"
}
}
},
"default": [],
"maxItems": 5
},
"search": {
"type": "string",
"maxLength": 100
},
"siteId": {
"type": "string",
"minLength": 1
},
"purpose": {
"enum": [
"all",
"lead",
"brand"
],
"type": "string",
"default": "all"
},
"sources": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50
},
"dateFrom": {
"type": "string",
"format": "date-time"
},
"pageSize": {
"type": "integer",
"default": 24,
"maximum": 240,
"minimum": 1
},
"platform": {
"enum": [
"reddit",
"x",
"linkedin",
"tiktok",
"youtube",
"instagram",
"threads",
"facebook",
"hackernews",
"bluesky"
],
"type": "string"
},
"scoreMax": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"scoreMin": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"favorites": {
"type": "boolean"
},
"keywordId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"sentiment": {
"enum": [
"positive",
"neutral",
"negative",
"unanalyzed"
],
"type": "string"
},
"upvotesMax": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"upvotesMin": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"commentsMax": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"commentsMin": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"needsResponse": {
"type": "boolean"
}
}
}| sourceMode |
| string |
| sourceJobId | string |
| maxDomainRating | integer |
| minDomainRating | integer |
| competitorDomain | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": 1
},
"search": {
"type": "string",
"maxLength": 200
},
"siteId": {
"type": "string",
"minLength": 1
},
"sortBy": {
"enum": [
"domainAuthority",
"opportunityScore",
"relevanceScore",
"qualityScore",
"riskScore",
"createdAt"
],
"type": "string",
"default": "domainAuthority"
},
"contact": {
"enum": [
"any",
"with",
"without"
],
"type": "string",
"default": "any"
},
"keyword": {
"type": "string",
"maxLength": 200
},
"perPage": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"pageType": {
"enum": [
"editorial_article",
"resource_page",
"listicle",
"comparison",
"directory",
"partner_page",
"other"
],
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"enum": [
"new",
"ready",
"rejected",
"blocked"
],
"type": "string"
},
"default": []
},
"projectId": {
"type": "string",
"minLength": 1
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc"
},
"sourceMode": {
"type": "string",
"const": "competitor_backlinks"
},
"sourceJobId": {
"type": "string",
"minLength": 1
},
"maxDomainRating": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"minDomainRating": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"competitorDomain": {
"type": "string",
"maxLength": 253
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"enabled",
"timezone",
"generationLeadHours",
"publishingDays",
"publishTime",
"mode",
"defaultCmsConnectionId"
],
"properties": {
"mode": {
"enum": [
"review_required",
"auto_publish_approved"
],
"type": "string"
},
"siteId": {
"type": "string",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"timezone": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"publishTime": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
},
"publishingDays": {
"type": "array",
"items": {
"type": "integer",
"maximum": 6,
"minimum": 0
},
"maxItems": 7
},
"generationLeadHours": {
"type": "integer",
"maximum": 720,
"minimum": 1
},
"defaultCmsConnectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
}
}| any |
| autoPublishAccountIds | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"campaignId",
"name",
"pageUrl",
"accountIds",
"cadence",
"startsAt",
"endsAt",
"maxPostsPerAccount",
"mode"
],
"properties": {
"mode": {
"enum": [
"review_required",
"auto_publish"
],
"type": "string"
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"endsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"siteId": {
"type": "string",
"minLength": 1
},
"cadence": {
"type": "object",
"required": [
"postsPerWeek",
"days",
"windowStart",
"windowEnd",
"timezone"
],
"properties": {
"days": {
"type": "array",
"items": {
"type": "integer",
"maximum": 6,
"minimum": 0
},
"maxItems": 7,
"minItems": 1
},
"timezone": {
"type": "string",
"minLength": 1
},
"windowEnd": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"windowStart": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"postsPerWeek": {
"type": "integer",
"maximum": 7,
"minimum": 1
}
}
},
"pageUrl": {
"type": "string",
"format": "uri"
},
"startsAt": {
"type": "string",
"format": "date-time"
},
"projectId": {
"type": "string",
"minLength": 1
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"minItems": 1
},
"campaignId": {
"type": "string",
"minLength": 1
},
"maxPostsPerAccount": {
"anyOf": [
{
"type": "integer",
"maximum": 60,
"minimum": 1
},
{
"type": "null"
}
]
},
"autoPublishAccountIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": [],
"maxItems": 20
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"siteId",
"contactId",
"status",
"source",
"provider",
"costMicros",
"idempotencyKey"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 1000
},
"siteId": {
"type": "string",
"minLength": 1
},
"source": {
"enum": [
"manual_review",
"provider"
],
"type": "string"
},
"status": {
"enum": [
"valid",
"risky",
"invalid"
],
"type": "string"
},
"provider": {
"type": "string",
"maxLength": 100,
"minLength": 2
},
"contactId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"minLength": 1
},
"costMicros": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"maxLength": 160,
"minLength": 8
},
"providerReference": {
"type": "string",
"maxLength": 300
}
}
}