Launch a competitor link export. PAID: max_credits (from quote_link_gap, approved by the user) is reserved at launch; when the export finishes, it is charged on the non spam referring domains delivered and the rest is refunded (credits_charged, credits_refunded). Call it sequentially: one launch at a time per account, shared with analyze_keywords (a concurrent launch gets 429 launch_in_progress, retry after a few seconds). Returns the export like get_link_gap: HTTP 201 (MCP http_status 201) = new export, credits reserved; 200 = idempotent replay of the existing export, nothing charged. While running is true, call get_link_gap with wait=40.

post/api/v1/link-gaps

Request

  • Base URL: https://12backlinks.com
  • URL: https://12backlinks.com/api/v1/link-gaps
  • Auth: HTTP bearer

Request body

targetstring required

Your site: a domain (example.com) or a URL. It is always fetched entirely. A URL other than the home page also measures that page when velocity is true.

analysis_idstring

Keyword entry: the analysis_id of a done analysis from one of your batches (see get_batch). Its ranking sites are the competitors to choose from. Not with batch_id.

batch_idstring

Batch entry: the batch_id of one of your batches (see list_batches). The competitors to choose from are the ranking sites of all its done analyses, merged by root domain: a site ranking on several keywords is fetched and charged once. The batch must be finished (get_batch with wait=40 until it is done). Not with analysis_id.

velocityboolean

Also fetch the referring domains gained and lost per month over 24 months for each site (spam included): +1 credit per site, refunded when unavailable. Default false.

max_creditsinteger required

Required. The max_credits of quote_link_gap that the user approved. If the maximum recomputed at launch is higher, the launch is refused with 409 max_credits_exceeded and nothing is charged.

waitinteger

Seconds to wait for the export before answering (0 to 45). Default 0 over REST, 40 over MCP. An export takes from a few seconds to a few minutes.

idempotency_keystring

Recommended. 16 to 128 characters [A-Za-z0-9_-]. Reuse the SAME key with the SAME input after a timeout: the existing export is returned without a new charge. Same key with a different input: 409.

Response

Idempotent replay: same idempotency_key and same input, existing export returned, nothing charged.

link_gap_idstring
origin'keyword' | 'list' | 'bulk'
batch_idstring

Only when origin is bulk: the source batch.

keywordstring nullable
domainstring nullable
langstring nullable
targetstring

Root domain of your site.

status'running' | 'done' | 'partial' | 'failed'
runningboolean

false once finished (or stuck for more than 2 hours, then closed).

created_atstring date-time
source'api' | 'ui'
keywords_usedinteger nullable

Only when origin is bulk: keywords of the batch used at launch.

target_completeboolean

Your site was fetched entirely; otherwise miss and have cannot be computed.

credits_reservedinteger

Maximum reserved at launch.

credits_chargedinteger nullable

Charged on the domains delivered; null until settled (never 0 by default).

credits_refundedinteger nullable

credits_reserved minus credits_charged, refunded; null until settled.

settledboolean
domains_deliveredinteger
rows_unavailable'target_incomplete'
next_stepstring

Changes

No recorded changes to this operation across all 1 revision of this API.