get_editorial_velocity_comparison
get_editorial_velocity_comparisonRead a comparison of editorial velocities, poll until it is done
Returns the comparison started by POST /api/v1/tools/editorial-velocity/comparisons. While status is
pending or running, call again every 15 seconds. Each site has its own state (queued, running, done,
failed); its numbers are null until it is done, never zero by default. analysisId links to the full
analysis of the site (GET /api/v1/tools/editorial-velocity?analysisId=...). A failed NO_DATES site may carry
sitemapCeiling, an upper bound read from the sitemap modification dates: at most total pages published or
modified since windowFrom. Present it as "at most N pages", never as a pace nor a count of articles; it is
never counted in summary nor in recommendation.
summary.median and summary.max are computed on the competitors measured (summary.measuredCompetitors),
never on your own site; summary.own is the perMonth of your site and summary.gap is median minus own.
recommendation.perMonth is the number of articles per month to publish to keep the median pace of the
competitors. It is only given with at least 3 competitors measured; otherwise recommendation is null and
recommendationReason says why (code too_few_competitors, measured the number measured).
status failed happens when the Google results of the keyword could not be read or held no competitor
(failureCode SERP_FAILED), or when the comparison could not be started (failureCode INTERNAL); nothing is
analysed and everything is given back.
billing says what the comparison cost and what was given back, place by place (refunds, with the
reason site_failed, reused, unused_place, serp_failed or not_started, and the status refunded, pending or
review). underReview is present only when true, the automatic refund stopped and is checked by our team.
It names no account. Reading settles the refunds that are due, whoever reads.
No quota is consumed. Whoever holds the comparisonId can read it, which is what makes share links work. Comparisons expire after 30 days. Reads not attributed to an account are capped at 1000 per IP address and per UTC day (shared with the reads of analyses), and crossing it returns 429 READ_RATE_LIMITED.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| comparisonId | Yes | The comparisonId returned by the creation call (22 characters). |