Repository navigation
AI Search: deprecate three prompts filters and document the new data source - #1
Merged
Merged
Conversation
…(DAT-917) - prompts-by-target / prompts-by-brand: mark filter[volume], filter[keyword_count] and filter[characters_count] as deprecated (removed on <CUTOVER_DATE>, 400 unsupported filter afterwards), document limit maximum 1000 and a 400 response. - Overview (aggregated, by-engine) and leaderboard: document the response changes since 2026-09-29 (average_position null, empty traffic/position time series, entity-based brand_presence, real previous/change values). - Prompts: volume null on ai-overview / 0 on LLM engines, date is the current month. - data-api.json regenerated from data-api.yaml. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wgf1DkCuX1WDHgjtcpzQ4y
filter[volume], filter[keyword_count] and filter[characters_count] were removed on 2026-10-14; the placeholder date is replaced in the YAML and the JSON alike. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wgf1DkCuX1WDHgjtcpzQ4y
mikhail-liubushkin
marked this pull request as ready for review
October 14, 2026 06:49
`npm install -g` puts js-yaml in the global prefix, which `node -e
"require('js-yaml')"` does not search, so the check failed with
MODULE_NOT_FOUND on every run. A local, unsaved install lands in
./node_modules (already in .gitignore) and resolves.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Wgf1DkCuX1WDHgjtcpzQ4y
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates the AI Search part of
openapi/data-api.yaml(and the generatedopenapi/data-api.json) for the move to the new AI Search data source and the prompts filter cut-over./v1/ai-search/prompts-by-target,/v1/ai-search/prompts-by-brandfilter[volume][from|to],filter[keyword_count][from|to]andfilter[characters_count][from|to]are markeddeprecated: truewith the description "Removed on 2026-10-14; requests that use it get 400 unsupported filter." The operation description says the same: the three filters were removed on 2026-10-14.limitdocumentsmaximum: 1000. A larger value gets a 400.400response is documented:limitabove 1000, or a filter that is no longer supported.200description lists the data changes since 2026-09-29:prompts[].volumeisnullforengine=ai-overviewand0for the LLM engines, anddateis the current month./v1/ai-search/overview/aggregated/time-series,/v1/ai-search/overview/by-engine/time-seriesThe
200description lists the data changes since 2026-09-29:summary.average_positionis alwaysnull.time_series.organic_traffic,time_series.overall_trafficandtime_series.average_positionare empty arrays.summary.brand_presencematches the brand as a recognized entity, not as text.summary.*.previousis the previous monthly snapshot, andchange_absolute/change_percentare computed from it. Before this change,previouswas alwaysnulland the change was reported as the current value and 100%./v1/ai-search/overview/leaderboard200description says thatbrand_presencematches the brand as an entity.Not changed
/v1/domain/aio/overview,/keywords-by-targetand/keywords-by-brandare not in this spec, so there is nothing to mark as removed (410).application/json: {}), as before. That is why the data changes are described in the response descriptions.Validation
redocly lint openapi/data-api.yaml: valid. Warnings went from 88 to 86 because the new400responses satisfyoperation-4xx-response.data-api.jsonwas regenerated from the YAML with the file's existing formatting: 2-space indent, ASCII escapes, no trailing newline.CI fix (
.github/workflows/validate.yml)The "Validate JSON matches YAML" step installed js-yaml with
npm install -g, whichnode -e "require('js-yaml')"cannot resolve, so the step failed withMODULE_NOT_FOUNDon every run (this PR was the first to trigger it). It now runsnpm install --no-save js-yaml: the module lands in./node_modules, which is already in.gitignore, and nopackage.jsonis written. "Lint & Validate" passes.🤖 Generated with Claude Code
https://claude.ai/code/session_01Wgf1DkCuX1WDHgjtcpzQ4y