RevenueScope: revenue-first analytics for your EC site

 ⟨61 unchanged words⟩ dates it uses the immediately preceding equal-length range. Or pass preset (last_4_weeks, last_12_weeks or year_to_date) instead of dates, for the same periods and comparison as the app's period picker: the period ends on the last Saturday that closes a complete week (weeks run Sunday to Saturday, judged in the site timezone), the comparison is the same number of days directly before it, and year_to_date starts on January 1 of the year of that Saturday. preset cannot be combined with start_date, end_date, compare_start_date or compare_end_date, and `period.preset` echoes it. Each row reports available prior values and deltas.  ⟨5 unchanged words⟩ , linear and time_decay. Candidate ad revenue is contextnot paid attribution. ad_spend_candidates returns ROAS (candidate revenue / ad spend) only for ad-only platforms (Google Ads, notYahoo! paidAds, attributionMicrosoft orAds, PaidCriteo, AttributionRTB House, MicroAd); others such as Meta include organic traffic and get roas_status=includes_organic. Monthly ad spend is prorated by overlapping days. No overall ROAS. Unattributed is the total of purchases that no session carries, shown as a separate row and not added to channel revenue. A purchase revenueafter a device change or cookie clearing belongs to the channel of the session it was made in (often Direct) and cannot be separated. revenue_breakdown.total_event_jpy is channel-attributed revenue plus Unattributed, not a separatetotal row.cut by purchase-event time. Some dimensions do not support country/device filters; unsupported ⟨10 unchanged words⟩ 

 ⟨62 unchanged words⟩ "minimum":1,"type":"integer"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"site_id":{"format":"uuid","type": ⟨22 unchanged words⟩ 

 ⟨23 unchanged words⟩ "type":["number","null"]},"previous_roas":{"type":["number","null"]},"previous_spend_jpy":{"type":["number","null"]},"roas":{"type":["number","null"]},"roas_status":{"enum":["available","includes_organic","no_spend","revenue_unavailable","spend_unavailable","filtered_scope"],"type":"string"},"spend_delta_jpy":{"type":["number","null" ⟨4 unchanged words⟩ ":["ad_channel","spend_jpy","candidate_revenue_jpy","roas","roas_status","previous_roas","previous_spend_jpy","spend_delta_jpy","previous_candidate_revenue_jpy","candidate_revenue_delta_jpy"], ⟨170 unchanged words⟩ :{"type":"number"},"end":{"type":"string"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"reference_bounds":{"const ⟨874 unchanged words⟩ 

Return the latest competitor SEO snapshot for the site (FD-041): which keywords each tracked competitor DOMAIN ranks for  ⟨41 unchanged words⟩ costs money and is triggered separately from the dashboard,RevenueScope app by the competitor-research Edge Function); it only reads  ⟨129 unchanged words⟩ explaining a research must be triggered from the dashboardRevenueScope app first — this tool cannot start one. site_id ⟨28 unchanged words⟩ 

 ⟨122 unchanged words⟩ caveats and limits are included in the response. Revenue values (revenue_jpy, ai_revenue_jpy, expected_revenue_gain and the bucket_summary revenue_jpy) are null when revenue_status is 'unconfirmed': null means unverified, not 0 yen. site_id is optional when OAuth-authenticated. Google Search only; data lags 1-2 days.

 ⟨28 unchanged words⟩ ":"number"},"revenue_jpy":{"type":["number","null"]}},"required":["count","revenue_jpy", ⟨108 unchanged words⟩ :"string"},"type":"array"},"notes":{"items":{"type":"string"},"type":"array"},"pages":{"items":{"additionalProperties":false," ⟨9 unchanged words⟩ ":"string"},"ai_revenue_jpy":{"type":["number","null"]},"ai_sessions":{"type":"number"}, ⟨66 unchanged words⟩ ,"null"]},"revenue_jpy":{"type":["number","null"]},"sessions":{"type":"number"}, ⟨76 unchanged words⟩ ["days"],"type":"object"},"revenue_status":{"enum":["confirmed","unconfirmed"],"type":"string"},"session_window":{"additionalProperties":false,"properties":{" ⟨90 unchanged words⟩ type":"object"}},"required":["site_id","revenue_status","period","window","session_window","basis ⟨8 unchanged words⟩ 

 ⟨17 unchanged words⟩ is the immediately preceding equal-length range. Omitting both keeps theuses dashboard'sa rolling now-minus-30-days window. Or pass preset (last_4_weeks, last_12_weeks or year_to_date) for the same periods as the app's period picker: the period ends on the last Saturday that closes a complete week (weeks run Sunday to Saturday, judged in the site time zone), and the comparison is the same number of days directly before it; year_to_date starts on January 1 of the year of that Saturday. preset cannot be combined with start_date or end_date, and `period.preset` echoes it. Each current and previous window uses a separate  ⟨130 unchanged words⟩ ) ranks only candidates among the current top 200;200, with the search screen's borders (shown rank, the average position rounded to a whole number, from 4 to 20, and at least 10 impressions); it is not the best opportunity across all queries. band='keeping' (default limit 10) returns the search screen's 上位維持 list (shown rank 1 to 3 and at least 10 impressions, most impressions first) and band='declining' (default limit 10) returns its 流入減 list (clicks fell by at least max(3, 20% of the earlier clicks), biggest loss first); both judge only within the current and previous top 200 queries by clicks, and each row has current and previous clicks, impressions and rank (shown_position is the whole-number rank the screen shows), `rise` (previous shown rank minus current, positive is up) and, for declining, click_loss and click_change_pct. Revenue values (est_revenue_jpy, rps_search_jpy, est_revenue_change, est_incremental_revenue_jpy) are null when revenue_status is 'unconfirmed': null means unverified, not 0 yen. Values may differ from the former keyword_breakdown_aggregate because ⟨20 unchanged words⟩ 

 ⟨8 unchanged words⟩ "all","enum":["all","striking","keeping","declining"],"type":"string"},"end_date":{ ⟨4 unchanged words⟩ ":1000,"minimum":1,"type":"integer"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"site_id":{"format":"uuid", ⟨15 unchanged words⟩ 

 ⟨12 unchanged words⟩ band":{"enum":["all","striking","keeping","declining"],"type":"string"},"band_criteria":{"additionalProperties":{"type":"number"},"type":"object"},"basis":{"type":"string"},"criteria" ⟨30 unchanged words⟩ :"string"},"type":"array"},"notes":{"items":{"type":"string"},"type":"array"},"period":{"additionalProperties":false,"properties":{" ⟨3 unchanged words⟩ ,"end":{"type":"string"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"start":{"type":"string"}},"required ⟨3 unchanged words⟩ ,"type":"object"},"previous_period":{"additionalProperties":false,"properties":{"days":{"$ref":"#/properties/period#/properties/period/properties/days"},"end":{"$ref":"#/properties/period/properties/end"},"start":{"$ref":"#/properties/period/properties/start"}},"required":["start","end","days"],"type":"object"},"revenue_estimate_basis":{"type":"string"},"revenue_status":{"enum":["confirmed","unconfirmed"],"type":"string"},"rows":{"anyOf":[{"items":{" ⟨19 unchanged words⟩ ,"null"]},"est_revenue_jpy":{"type":["number","null"]},"impressions":{"type":"number"},"query":{"type":"string"},"rps_search_jpy":{"type":["number","null"]},"top_page":{"type":["string", ⟨31 unchanged words⟩ 

 ⟨16 unchanged words⟩ inclusive JST dates; comparison dates are not supported. Or pass preset (last_4_weeks, last_12_weeks or year_to_date) for the same periods as the app's period picker: the period ends on the last Saturday that closes a complete week (weeks run Sunday to Saturday, judged in the site time zone), and year_to_date starts on January 1 of the year of that Saturday; preset cannot be combined with start_date or end_date, and `period.preset` echoes it. Omitting bothall of them preserves the current now-minus-30-days rolling window, which may ⟨33 unchanged words⟩  week for longer windows; pass it to override. Weeks run Sunday to Saturday and each weekly `date` is that week's Sunday; weeks at the edge of the period hold only the days inside it. Buckets without GSC rows are omitted. Google-search only; ⟨21 unchanged words⟩ 

 ⟨16 unchanged words⟩ "minLength":1,"type":"string"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"site_id":{"format":"uuid","type": ⟨16 unchanged words⟩ 

 ⟨37 unchanged words⟩ ,"end":{"type":"string"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"start":{"type":"string"}},"required ⟨94 unchanged words⟩ 

 ⟨10 unchanged words⟩  (ROAS, saturation) do not match the renewedcurrent RevenueScope dashboard.definitions. It always returns status='stopped' with the reason and ⟨28 unchanged words⟩ 

Return headline KPIs (revenue, orders, sessions, RPS, AOV, CVR), engagement metrics ⟨51 unchanged words⟩  omitted, the preceding equal-length range is used. Or pass preset (last_4_weeks, last_12_weeks or year_to_date) instead of dates, for the same periods and comparison as the app's period picker: the period ends on the last Saturday that closes a complete week (weeks run Sunday to Saturday, judged in the site timezone), the comparison is the same number of days directly before it, and year_to_date starts on January 1 of the year of that Saturday. preset cannot be combined with start_date, end_date, compare_start_date or compare_end_date, and `period.preset` echoes it. Revenue-dependent metrics (revenue, orders, RPS, AOV, CVR) are null unless purchase measurement is confirmed; null  ⟨8 unchanged words⟩ isError=true and must not be read as zero. PaidNo Attributionoverall ROAS is unavailable.returned (kpis.roas is always null); per-platform ROAS for ad-only platforms is in get_breakdown ad_spend_candidates. Optional country (ISO2) and device filters scope ⟨7 unchanged words⟩ 

 ⟨26 unchanged words⟩ ,"end_date":{"$ref":"#/properties/start_date"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"site_id":{"format":"uuid","type": ⟨14 unchanged words⟩ 

 ⟨177 unchanged words⟩ "},{"type":"null"}]},"orders":{"$ref":"#/properties/kpis/properties/revenue"},"revenue":{"additionalProperties":false,"properties":{" ⟨32 unchanged words⟩ "#/properties/kpis/properties/revenue"}},"required":["revenue","orders","sessions","rps","aov","cvr"," ⟨34 unchanged words⟩ :{"type":"number"},"end":{"type":"string"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"reference_bounds":{"const ⟨321 unchanged words⟩ 

Return today's activity for a site, matching the RevenueScope 今日の状況 screen. Today is: the site's timezone from 00:00 to now;now, valuesprovisional arevalues. provisional.No screen of the RevenueScope app shows this view now. Purchase events are observed events, not confirmed orders; unverified revenue and unavailable sections are not zero. Sample-site values doare notthose matchof thea screen'ssample fixedstore, samplenot data.your own site. No event-level or visitor-level rows are returned. For ⟨24 unchanged words⟩ 

 ⟨314 unchanged words⟩ ,"end":{"type":"string"},"preset":{"enum":["last_4_weeks","last_12_weeks","year_to_date"],"type":"string"},"reference_bounds":{"const":"start_inclusive_end_exclusive","type": ⟨247 unchanged words⟩ 

 ⟨5 unchanged words⟩  returns a budget split: the old method reliedweighted onevery channel by revenue ÷ ad spend, which theRevenueScope renewedno RevenueScopelonger dashboardprovides does(it notreturns treatROAS asfor Paidad-only Attributionplatforms ROAS.only). It always returns status='stopped' with the reason,  ⟨6 unchanged words⟩  ad spend next to candidate paid-session revenue, not aswith ROAS for ad-only platforms only) and the resume plan (a new method ⟨14 unchanged words⟩ 

`get_breakdown` compares `channel`, `entry_page`channel, and `visitor_history` rows for the requested period and the preceding equal-length window (or compare_start_date/compare_end_date). Each row reports current values plus previous values and deltas where comparable. Channel attribution_model supports last_touchentry_page, first_touchvisitor_history, linear,page and time_decay.session_attribute Adrows. spendBy isdefault groupedit throughuses `ad_channel_mapping`the (site-specificsite's rowscalendar overridemonth globalto rows),date and candidate revenue is summedcompares fromwith matchingthe last_touchprior sessionmonth channelsthrough regardlessthe ofsame attribution_model.calendar Candidateday values(clamped areto contextthe only;prior theymonth's arelast notday). paidPass attributionstart_date and no Paid Attribution ROAS is calculated. Unattributed purchaseend_date revenuetogether appearsfor asanother ainclusive separatecalendar rowrange andin isthe excludedsite's fromanalysis attributedtimezone; totals.optionally `entry_page`pass usescompare_start_date dashboard_entry_page_summary_window;and country/devicecompare_end_date. filtersWithout areexplicit unsupportedcomparison there.dates `visitor_history`it uses the dashboard's visitor-type history rule. `revenue_status='unconfirmed'` meansimmediately availablepreceding signalsequal-length dorange. notEach confirmrow revenuereports history:available monetaryprior fieldsvalues and monetary deltas are null, while session counts remain numeric; it does not prove purchase measurement is unconfigured. Internaldeltas. retrievalChannel failuresattribution_model returnsupports `isError=true`last_touch, `revenue_status='error'`first_touch, and `revenue:null`. `is_demo`linear isand independenttime_decay. ofCandidate revenue_status.ad Comparisonsrevenue areis availablecontext only when the preceding window has observed trend data, no preceding-window fetch error occurred, and the first non-bot, non-dwell-only session's site-calendar datenot ispaid onattribution or before thePaid precedingAttribution window'sROAS. startUnattributed date.purchase `page`revenue andis `entry_page`a defaultseparate torow. atSome mostdimensions 20do rowsnot andsupport reportcountry/device omittedfilters; counts.unsupported `filter.channel`axes drillsare intoidentified campaignin rows.notes. site_id is optional when OAuth-authenticated. Default period is 30 days; accepted values are today, 7d, 30d, 90d, or 1-365. Explicit start_date/end_date are inclusive calendar dates in the site's analysis timezone. Spend uses inclusive JST dates from `ad_spend_daily.date`; trend and session windows use site timezone. Country (ISO2) and device filters apply where the source RPC supports them; unsupported axes are called out in notes.

 ⟨62 unchanged words⟩ "minimum":1,"type":"integer"},"period":{"anyOf":[{"const":"today","type":"string"},{"const":"7d","type":"string"},{"const":"30d","type":"string"},{"const":"90d","type":"string"},{"maximum":365,"minimum":1,"type":"integer"}],"default":"30d"},"site_id":{"format":"uuid","type": ⟨22 unchanged words⟩ 

Return a content 'playbook' for the site: every content page classified into ONE of five action buckets over a weekly-style windowand comparisonpage (currentevidence. windowBy vsdefault the immediately preceding window of equal length), ranked by search-opportunity × session gain so you can tell the user which page to GROW next and what to do: within the 'striking' bucket rows are ordered by expected_sessions_gain DESC (the band-CTR headroom that is the actionable lever there), while the other buckets keep real landing revenue DESC (largest revenue at stake first). This surfaces search intent to add sessions (grow the traffic denominator), NOT CVR — a page already winning on sessions/revenue but with zero clicks still shows up. Buckets: 'decaying' (search clicks actually fell, OR the page had real traffic (previous clicksN=7 ≥3)days and its rank slid ≥2 positions from within the click zone while clicks did NOT grow → refresh/rewrite; a rank slide alone with growing/negligibleGSC clicksdata is NOT decay — search clicks aredelayed theby primary3 signal,days. positionTo onlychoose a leading indicator)window, 'striking' (has striking-distance queries at positions 4-20 with click upside but clicks stillpass lowstart_date →and pushend_date thosetogether: queriesend_date up;must topbe 3today's listeddate in striking_queries), 'rising' (clicks grew significantly → produce more of this, strengthenJapan CTA)time, 'dormant' (has impressions but ~0 clicks and its main queryN is far below the click zone → big rewrite or consolidate; zero-pageview pure-rank pages surface here), 'stable' (none of the above → watch). Each page also carries current/previous clicks·impressions·avg_position, is_new, landing sessions/engaged/revenue_jpy, AI-referredend_date sessions/revenue/sources,minus expected_sessions_gainstart_date (the window's expected incremental sessions from2-365 striking-banddays; queriese.g. —September a21 searchthrough clickSeptember is28 ~1sets sessionN=7), so it is NOT re-converted via CTR; normalize to a monthly figure with the window length), and expected_revenue_gain (expected_sessions_gain × page RPS, returned ONLY when revenue>0 and sessions>=5 — display-only projection,pair neverdescribes a sort key). The deterministic action mapping and all (provisional) thresholds come back inlength `criteria`;ending thetoday modelrather doesthan the narrative interpretation (mcp-first). RowsGSC withsource confidence='low'dates. carryThe `caveats`response —separates 'geo_winning_suspect'`window` (AI Overview/citations likely substitute the click:actual aJST GEOGSC windates, don't break the page; cross-check get_ai_trafficinclusive), 'zero_click_suspect' (SERP-feature occupation or intent-mismatch/polysemous query: verify the live SERP first),from 'ai_cited'`session_window` (decayingsessions, butrevenue theand AI citation is alive) — verify before acting on low-confidence rows;metrics definitionsover inN×24 criteria.caveat_flags.hours Theending responseat isdatabase summary-firststatement (token-awaretime): `bucket_summary`. always`session_window` holdsgives the FULL pre-limit distributionrelative (per-bucketstart/end count/revenue/clicks)and plusduration; `total_pages`,exact whiletimestamps `pages`are returnsunavailable onlybecause the topRPC rowsdoes innot priorityreturn orderits `now(default limit 15, max 200); pass bucket='striking' etc. to drill into one bucket, and check `truncated` — when present it tells how many rows were cut and how to fetch them. GSC-driven and Google-search only; data lags 1-2 days so the current window's right edge sits a few days back. When narrating a bucket to the user, scope it to Google search — say 'search traffic to this` pagevalue. isSearch declining'classifications, NOT 'this page is declining'; the classification is a search-trend diagnosisthresholds, not overall page healthbucket_summary, so a page labeled 'decaying' can be thriving on Direct/social/AI. Before calling a negative bucket (decaying/dormant) arow problemprioritization, cross-check the row's landing sessions/revenue_jpycaveats and ai_sessions. site_id is OPTIONAL when OAuth-authenticated. Default window is the last 7 days vs the prior 7; pass period='30d'/'90d' or a raw day count (2-365). Window date boundslimits are INCLUSIVE on both ends, so period=Nd actually spans N+1 calendar dates (the real range isincluded in `window`); both windows share the same length, so the comparison stays symmetric.response. Thissite_id is the cross-page action snapshot; for one page's timeoptional serieswhen useOAuth-authenticated. get_page_trend,Google andSearch foronly; AI-referreddata pageslags use1-2 get_ai_traffic(mode='referred').days.

 ⟨12 unchanged words⟩ ,"stable"],"type":"string"},"limitend_date":{"maximumpattern":200,"minimum^\\d{4}-\\d{2}-\\d{2}$":1,"type":"integerstring"},"periodlimit":{"anyOfmaximum":[{200,"constminimum":"7d"1,"type":"stringinteger"},{"const":"30d","typesite_id":"string"},{"constformat

 ⟨315 unchanged words⟩ ["days"],"type":"object"},"session_window":{"additionalProperties":false,"properties":{"basis":{"const":"database_statement_time","type":"string"},"duration_days":{"maximum":365,"minimum":2,"type":"integer"},"duration_hours":{"maximum":8760,"minimum":48,"type":"integer"},"exact_timestamps_available":{"const":false,"type":"boolean"},"from_relative":{"type":"string"},"to_relative":{"const":"now()","type":"string"}},"required":["basis","duration_days","duration_hours","from_relative","to_relative","exact_timestamps_available"],"type":"object"},"site_id":{"type":"string"},"total_pages" ⟨47 unchanged words⟩ ,"required":["site_id","period","window","session_window","basis","assumptions","limitations","criteria ⟨5 unchanged words⟩ 

Return search-query performance from Google Search Console forquery themetrics. givenPass period.start_date band='all'and end_date together (defaultinclusive JST GSC dates); returnscomparison per-queryis metricsthe —immediately clicks/impressions/CTR/avgpreceding position/topequal-length landingrange. pageOmitting plusboth ankeeps estimatedthe revenuedashboard's perrolling querynow-minus-30-days (=window. 検索Each organiccurrent RPSand ×previous clicks,window uses a conservativeseparate estimatedashboard_keywords RPC call, 0capped untilat the200 sitequeries hasby 検索clicks. organic`period` revenue),and ranked`previous_period` byshow clicksthe (defaultactual limitJST 100).date Eachranges; row`date_basis` also/ carries`timezone` identify the period-over-periodGSC changecalendar. vs`source_windows` exposes the previousexact equal-lengthp_from/p_to window:timestamps clicks_changeused (traffic)for andboth est_revenue_changeRPC (money)calls, bothwhether %the deltasGSC (nulldate =bounds theare queryinclusive, isand NEW,any i.e.JST haddate noshared clicks/revenueby lastthe periodtwo —windows. renderThe asrolling '新規',default nothas 0%).one Comparingshared theboundary twodate; surfacesexplicit RS'sdate signatureranges insighthave —none. e.g.band='all' clicksreturns +74%up butto est_revenuelimit −21%rows means(default traffic100) grewwith whileclicks, moneyimpressions, fellCTR, somethingaverage GA4/GSCposition, cannottop showpage sideand byestimated side.revenue band='striking'(search-organic returnsRPS the× SEOGoogle actionclicks); list:query-matched querieschanges 'strikingand distance'`truncated` fromdisclose theomitted/source-limited toprows. (rankingA ~4-20query withabsent realfrom impressions)the whereprevious improvingtop a200 fewmay positionsappear yieldsnew. theExplicit biggestdates click/revenueinclude gainboth JST GSC dates, rankedwhile bysession estimatedRPS revenueuses opportunity[start, (incrementalend) clicksand ×excludes search-organicthe RPS,final microsecond. band='striking' (default limit 10); ranks only candidates among the methodologycurrent top 200; it is fixednot inthe code.best site_idopportunity isacross OPTIONALall whenqueries. OAuth-authenticated.Values Defaultmay perioddiffer isfrom the lastformer 30keyword_breakdown_aggregate days;because passdate period='today'/'7d'/'90d'boundaries, orsource alimit rawand dayreturned countquery (1-365).set differ. Google-search only.only; data lags 1-2 days. site_id is optional when OAuth-authenticated.

 ⟨11 unchanged words⟩ ,"striking"],"type":"string"},"limitend_date":{"maximum":1000,"minimum":1,"type$ref":"integer#/properties/start_date"},"period":{"anyOflimit":[{"const":"today","typemaximum":"string"}1000,{"constminimum":"7d"1,"type":"stringinteger"},{"const":"30d","typesite_id":"string"},{"constformat":"90d

 ⟨41 unchanged words⟩ ,"target_position"],"type":"object"},"date_basis":{"const":"jst_calendar_date","type":"string"},"limitations":{"items":{"type":"string" ⟨18 unchanged words⟩ ,"days"],"type":"object"},"previous_period":{"$ref":"#/properties/period"},"revenue_estimate_basis":{"type":"string"},"rows" ⟨106 unchanged words⟩ ,"site_id":{"type":"string"},"source_windows":{"additionalProperties":false,"properties":{"current":{"additionalProperties":false,"properties":{"p_from":{"type":"string"},"p_to":{"type":"string"}},"required":["p_from","p_to"],"type":"object"},"gsc_date_bounds":{"const":"inclusive","type":"string"},"previous":{"$ref":"#/properties/source_windows/properties/current"},"shared_jst_dates":{"items":{"type":"string"},"type":"array"}},"required":["current","previous","gsc_date_bounds","shared_jst_dates"],"type":"object"},"timezone":{"const":"Asia/Tokyo","type":"string"},"truncated":{"anyOf":[{"additionalProperties":false,"properties":{"omitted_at_least":{"minimum":0,"type":"integer"},"shown":{"minimum":0,"type":"integer"},"source_limited":{"type":"boolean"}},"required":["shown","omitted_at_least","source_limited"],"type":"object"},{"type":"null"}]},"warning":{"type":"string"}},"required":["site_id","band","period","previous_period","date_basis","timezone","source_windows","rows"],"type":"object"}

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{},"type":"object"}

Return how ONE page's Google Search performance changed over time (FD-040) — the time-axis drill-down for a page surfaced by get_breakdown(dimension='page'). Given a `page` (a normalized path like '/news/rps-revenue-per-session-guide' or a full URL — both resolve), returns a `series` of day or week buckets, each withtime. clicks,Pass impressions,start_date and impression-weighted avg_position, plus a `summary` (first/last/best/worst position, position_delta, click & impressionend_date totals).together avg_positionas isinclusive aJST RANK:dates; smallercomparison isdates better,are sonot asupported. NEGATIVEOmitting position_deltaboth meanspreserves the page's ranking IMPROVEDcurrent overnow-minus-30-days therolling window (e.g. 12.0 → 9.0 = delta −3.0). Use this to verify whether SEO work on a page paid off (rank, rosewhich /may clickstouch grew)31 orJST slipped.dates Bucketsbecause whereGSC thefilters pageby neverdate appearedinclusively. inExplicit searchdates are omitted (gaps), so theconverted seriesto canJST beday shorterboundaries thanfor theGSC period.rows. `granularity` defaults to 'day'day for windows up to ~35about 35 days and 'week'week for longer (weekly smooths daily noise);windows; pass it to override. site_id is OPTIONAL when OAuth-authenticated. Default period is the last 30 days; pass period='today'/'7d'/'90d' orBuckets awithout rawGSC dayrows countare (1-365).omitted. Google-search only; data lags 1-2 days. Thissite_id is per-page;optional forwhen theOAuth-authenticated. For cross-page snapshotsnapshots use get_breakdown(dimension='page'), and; for per-query (keyword)query trends use get_keyword_performance.

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{"end_date":{"$ref":"#/properties/start_date"},"granularity":{"enum":["day","week" ⟨3 unchanged words⟩ "minLength":1,"type":"string"},"period":{"anyOfsite_id":[{"constformat":"todayuuid","type":"string"},{"const":"7d","typestart_date":"string"},{"const":"30d","typepattern":"string"},^\\d{"const":"90d","type":"string"4},-\\d{"maximum":365,"minimum":1,"type":"integer"}],"default":"30d"2},"site_id":-\\d{"format":"uuid

 ⟨4 unchanged words⟩ sessions, RPS, AOV, CVR), engagement metrics, current and previous daily trends with cumulative revenue, bot-excluded session count (null with a note when that count cannot be retrieved, and null as not applicable for a samplethe site's today-only window,calendar matchingmonth get_today),to period_observation_statusdate, and ad-spend availability / Path A/Bcompared contextwith forthe aprior sitemonth andthrough period.the Revenue-dependentsame metricscalendar andday trend(clamped revenueto arethat nullmonth's unlesslast purchaseday). measurementPass isstart_date confirmed;and nullend_date meanstogether unverified,for notanother zero.inclusive Whencalendar arange confirmedin periodthe hassite's noanalysis traffic,timezone; period_observation_statusoptionally ispass no_observationcompare_start_date and current revenue, RPS,compare_end_date. AOV,If andcomparison CVRdates are null; observed zero revenue remainsomitted, numericthe zero.preceding Aequal-length missingrange revenueis historyused. aloneRevenue-dependent doesmetrics notare shownull thatunless purchase measurement is unconfigured. Whenconfirmed; revenuenull ismeans unverified, explain that sales are unverified and guide the user to check purchase measurement; do not claim it is not set up. On a requiredzero. current-dataRequired retrieval failure, the toolfailures returnsreturn isError=true, revenue_status='error', revenue=null and error_code='retrieval_failed';must nevernot readbe itread as zero. A previous-window RPC failure keeps current data and makes comparison_status unavailable, with previous KPI/trend fields null. Trend conversions is an observed purchase-event count and is not a confirmation of revenue measurement. Paid Attribution ROAS is unavailable; kpis.roas remains null for response compatibility and must not be presented as a measured ROAS. Sessions and engagement metrics remain available independently. AOV and RPS are null when their denominator is zero. Useunavailable. optionalOptional country (ISO2, e.g. 'JP') and/orand device ('mobile'/'desktop'/'tablet') tofilters scope session-derived metrics. site_id is optional when OAuth-authenticated. Default period is the last 30 days; pass period='today'/'7d'/'90d' or a raw day count (1-365). For exact calendar dates in the site's analysis time zone, pass start_date and end_date, optionally with comparison dates. Revenue/sessions/RPS/AOV/avg_duration change is percentage or null when the prior value is zero; CVR and bounce_rate change is a percentage-point delta.

 ⟨26 unchanged words⟩ ,"end_date":{"$ref":"#/properties/start_date"},"period":{"anyOf":[{"const":"today","type":"string"},{"const":"7d","type":"string"},{"const":"30d","type":"string"},{"const":"90d","type":"string"},{"maximum":365,"minimum":1,"type":"integer"}],"default":"30d"},"site_id":{"format":"uuid","type": ⟨14 unchanged words⟩ 

Return today's activity for a site, matching the RevenueScope 今日の状況 screen: sessions, RS-observed revenue, purchase-event count, bot-excluded sessions, new/returning sessions, and reaction tables by channel, generative-AI channel and entry page (top 50) with average duration, bounce rate and pages per session.screen. Today is the site's time zonetimezone from 00:00 to now; values are provisional. purchase_eventsPurchase isevents anare observed event countevents, not confirmed orders. Revenue values are null when purchase measurement is unconfirmed; null meansorders; unverified, not zero,revenue and does not prove measurement is unconfigured. A table with status='error' is unavailable, not empty. Items in not_providedsections are unavailable, never 0. measurement_status='not_started' means the site has never received tracking data:not countszero. areSample-site nullvalues (unknown),do not 0. For sample sites (is_demo=true)match the 今日の状況 screen showsscreen's fixed sample data, so these values do not match that screen.data. No event-level or visitor-level rows are returned. For comparison with yesterday at the same time, use get_summary with period='today'.start_date and end_date both set to today's site-local date. site_id is optional when OAuth-authenticated.

List the sites this signed-in account can analyze, in two groups. Requires a RevenueScope account (OAuth); noEach site registration is needed. my_sites = the sites connected to the account (display name, domain, timezone, is_demo). demo_sites = operator-curated sample sites,includes withits timezone and thetoday's site'sdate is_demoin flag.that Onlytimezone. callRequires aOAuth; siteno asite sampleregistration whenis is_demo=true.needed. Prefer my_sites; if site_id is omitted, analytics tools use the is_primary=trueprimary site. When my_sites is empty, analytics tools default touse the first curated demo site and say so; tell the user the numbers comeidentify fromit aas sample site, not their own. A demo site can always be viewed by passing its site_id.data.

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{},"type":"object"}

 ⟨20 unchanged words⟩ "},"timezone":{"type":"string"},"today":{"type":"string"}},"required":["site_id","label","timezone","today","is_demo"],"type":"object"},"type" ⟨24 unchanged words⟩ "},"timezone":{"type":"string"},"today":{"type":"string"}},"required":["site_id","name","domain","is_primary","created_at","timezone","today","is_demo"],"type":"object"}, ⟨11 unchanged words⟩ 

 ⟨370 unchanged words⟩ items":{"enum":["get_breakdown","get_priority_insights","get_summary"],"type":"string"},"type":" ⟨15 unchanged words⟩ {"enum":["analytics_summary","analytics_breakdown","priority_insights","analytics_today"],"type":"string"},"show_breakdown": ⟨692 unchanged words⟩ 

 ⟨576 unchanged words⟩  page's time series use get_page_trend, and for AI-citationAI-referred gapspages use get_ai_traffic(mode='gaps'mode='referred').

Top priority insights (stopped)

Return the top 3 prioritized, pre-computed DIAGNOSES for the site over the given period — 'what should I act on thisSTOPPED. week',This rankedtool byno revenuelonger impact.returns Unlikeinsights: get_summaryits /old get_breakdownrules (which return data)ROAS, this applies a deterministic rule engine over KPIsaturation) period-over-perioddo changes,not per-channelmatch RPS/ROAS/saturation,the andrenewed AI-assistantRevenueScope referraldashboard. growth,It andalways returns ranked findings (revenue-trend swings, high-efficiency channels to scale, over-allocated low-efficiency channels, loss-making/saturated ad channels, revenue concentration risk, emerging AI traffic) — eachstatus='stopped' with a severity (risk/opportunity/watch), the numbers,reason and a recommended action. The priority judgmentthe istools fixedto inuse codeinstead (not LLM-generated). site_id is OPTIONAL when OAuth-authenticated.get_summary Defaultfor period is 30 days;KPIs, passget_breakdown period='today'/'7d'/'90d'for orchannel a/ rawentry-page day/ countvisitor-history (1-365changes). period and previous_period describe the KPI engine's current and previous windows; each returned insight carries source_boundaries because channel, ad-spend, and AI signals can use different source windows. ReturnsDo fewernot thanpresent 3anything whenfrom fewerthis rulestool fireas (noa padding).recommendation.

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{"period":{"anyOf":[{"const":"today","type":"string"},{"const":"7d","type":"string"},{"const":"30d","type":"string"},{"const":"90d","type":"string"},{"maximum":365,"minimum":1,"type":"integer"}],"default":"30d"},"site_id":{"format":"uuid","type": ⟨3 unchanged words⟩ 

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{"assumptions":{"items":{"type":"string"},"type":"array"},"basis":{"type":"string"},"data_freshness":{"additionalProperties":false,"properties":{"bot_classification_delay_definitions":{"additionalProperties":false,"properties":{"burst_cluster_fallback":{"type":"string"},"burst_cluster_primary":{"type":"string"},"single_page_zero_dwell":{"type":"string"}},"required":["burst_cluster_primary","burst_cluster_fallback","single_page_zero_dwell"],"type":"object"},"bot_classification_delay_minutes_max_by_rule":{"additionalProperties":false,"properties":{"burst_cluster_fallback":{"const":480,"type":"number"},"burst_cluster_primary":{"const":20,"type":"number"},"single_page_zero_dwell":{"const":480,"type":"number"}},"required":["burst_cluster_primary","burst_cluster_fallback","single_page_zero_dwell"],"type":"object"},"delay_bounds_assume_scheduled_jobs_operational":{"const":true,"type":"boolean"},"generated_at":{"format":"date-time","type":"string"},"may_change_because":{"items":{"enum":["live_ingestion","open_window","moving_window","delayed_bot_classification"],"type":"string"},"type":"array"},"provisional":{"const":true,"type":"boolean"}},"required":["generated_at","provisional","may_change_because","bot_classification_delay_minutes_max_by_rule","bot_classification_delay_definitions","delay_bounds_assume_scheduled_jobs_operational"],"type":"object"},"insights":{"items":{"additionalProperties":false,"properties":{"change":{"type":["number","null"]},"detail":{"type":"string"},"id":{"type":"string"},"impact_score":{"type":"number"},"metric":{"type":"string"},"rank":{"type":"number"},"recommended_action":{"type":"string"},"severity":{"enum":["risk","opportunity","watch"],"type":"string"},"source_boundaries":{"items":{"$ref":"#/properties/period/properties/source_boundaries/items"},"type":"array"},"title":{"type":"string"},"value":{"type":"number"}},"required":["id","severity","title","detail","metric","value","change","recommended_action","impact_score","rank","source_boundaries"],"type":"object"},"type":"array"},"limitations":{"items":{"type":"string"},"type":"array"},"period":{"additionalProperties":false,"properties":{"calendar_dates_touched":{"minimum":0,"type":"integer"},"days":{"type":"number"},"duration_hours":{"type":"number"},"end":{"type":"string"},"reference_bounds":{"const":"start_inclusive_end_exclusive","type":"string"},"reference_end_at":{"format":"date-time","type":"string"},"reference_start_at":{"format":"date-time","type":"string"},"source_alignment":{"enum":["exact","mixed"],"type":"string"},"source_boundariesalternatives":{"items":{"additionalProperties":false,"properties":{"

{"openWorldHint":false,"readOnlyHint":true,"title":"Top priority insights (stopped)"}

 ⟨23 unchanged words⟩  a note when that count cannot be retrieved, and null as not applicable for a sample site's today-only window, matching get_today), period_observation_status, and ad-spend availability / Path  ⟨246 unchanged words⟩ 

 ⟨417 unchanged words⟩ items":{"enum":["get_breakdown","get_priority_insights","get_summary"],"type":"string"},"type":" ⟨15 unchanged words⟩ {"enum":["analytics_summary","analytics_breakdown","priority_insights","analytics_today"],"type":"string"},"show_breakdown": ⟨136 unchanged words⟩ 

List the sites this callersigned-in account can analyze, in two groups. Requires a RevenueScope account (OAuth); no site registration is needed. my_sites = the sites connected to the signed-in account (display name, domain, timezone, is_demo); empty when not signed in.. demo_sites = operator-curated sites for tryingsample RevenueScopesites, with timezone and the site's is_demo flag. Only call a site a sample when is_demo=true. When signed in (OAuth), prefer my_sitesPrefer and,my_sites; if site_id is omitted, default analytics tools touse the is_primary=true site. When NOTmy_sites signedis inempty, my_sitesanalytics istools empty:default useto athe demo_sitesfirst site_iddemo site and disclosesay itsso; is_demotell status.the user the numbers come from a sample site, not their own. A demo site can always be viewed by passing its site_id.

Suggest budget allocation (stopped)

Return a proposed monthly budget split across paid ad channels (Google Ads / Meta / TikTok Ads / Yahoo! Ads / LINE Ads etc.). site_id is OPTIONAL when the request is OAuth-authenticated. Path B (ad spend connectedSTOPPED. —This anytool channelno withlonger spend>0returns ina thebudget period)split: weight = ROAS × (1 − saturation)the whereold ROASmethod isrelied RS-measuredon revenue ÷ spend (FD-030ad A-1spend, same aswhich the dashboard — NOT platform-reported conversion_value). saturation は RSrenewed 自身では推定せず、広告データとして供給された場合のみ使用するRevenueScope (推定エンジンはdashboard W17+)。値が無いチャネルはdoes ROASnot のみで加重し効率投下上限をかけないtreat —as limitationsPaid に明記する。⚠Attribution 配分候補は広告プラットフォーム単位ROAS. (MetaIt /always Googlereturns Adsstatus='stopped' …)with で、Instagramthe とreason, Facebookthe のようにセッション側の粒度が細かいチャネルは所属プラットフォームへ畳んで扱うalternative (FD-055)。get_breakdown Pathlists Aeach (nochannel's ad spend): RPS-weighted proportional split with explicitnext ±20-30%to caveatscandidate andpaid-session arevenue, connect_incentive_message.not Defaultas periodROAS) forand the underlying ROAS/RPS data is 30 days; pass period='today' / '7d' / '90d' or a raw dayresume countplan (1-365) to override.a LLMsnew shouldmethod passafter `assumptions`,paid-traffic `limitations`,classification). andDo `connect_incentive_message`not throughpresent verbatimanything —from theythis aretool hardcodedas honesta axis.recommendation.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"monthly_budget_jpy":{"maximum":100000000,"minimum":0,"type":"number"},"period":{"anyOf":[{"const":"today","type":"string"},{"const":"7d","type":"string"},{"const":"30d","type":"string"},{"const":"90d","type":"string"},{"maximum":365,"minimum":1,"type":"integer"}],"default":"30d"},"site_id":{"format":"uuid","type":"string"}},"required":["monthly_budget_jpy"],"type":"object"}

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{"allocationalternatives":{"items":{"additionalProperties":false,"properties":{"change_jpy":{"type":["number","null"]},"change_pct":{"type":["number","null"]},"channeltool":{"type":"string"},"current_jpy":{"type":["number","null"]},"proposed_jpy":{"type":"number"},"rationaleuse_for":{"type":"string"}},"required":["channel","current_jpy","proposed_jpy","change_jpy","change_pcttool","rationaleuse_for"],"type":"object"},"type":"array"},"assumptions":{"items":{"type":"string"},"type":"array"},"connect_incentive_messageresume_plan":{"type":["string","null"]},"expected_roas_current":{"type":["number","null"]},"expected_roas_proposed":{"type":["number","null"]},"expected_roas_uplift_pct":{"type":["number","null"]},"limitations":{"itemssite_id":{"type":"string"},"type":"array"},"monthly_budget_jpystatus":{"typeconst":"numberstopped"},"next_action":{"

{"openWorldHint":false,"readOnlyHint":true,"title":"Suggest budget allocation (stopped)"}

Consolidated breakdown tool. Pick `dimension`: 'channel' returns per-channel sessions/revenue/RPS plus`get_breakdown` engagementcompares (visitors`channel`, avg dwell seconds`entry_page`, bounce rate) and bot_excluded_count (bot sessions removed from human metrics; a channel with sessions=0 but bot_excluded_count>0 is bot-only traffic, kept so it is not`visitor_history` mistakenrows for 'no traffic')the andrequested —period whenand adthe spendpreceding isequal-length connectedwindow (Pathor Bcompare_start_date/compare_end_date) — spend/ROAS/saturation; plus an. 'Unattributed'Each row (is_unattributed=true) for purchase revenue not tied to any channel, with a revenue_breakdown summary (total_event_jpy/attributed_jpy/unattributed_jpy); pass attribution_model ('last_touch' default / 'first_touch' / 'linear' / 'time_decay')reports tocurrent switchvalues howplus purchaseprevious revenuevalues and orders are attributed across channels — same models as the dashboard's attribution selector; revenue_jpy/rps_jpy/orders/aov_jpy/cvr change,deltas whilewhere sessions/engagement/bot/spend/ROAScomparable. areChannel model-independentattribution_model [ad-platformsupports rowslast_touch, is_ad_platform=truefirst_touch, are entirely model-independentlinear, revenue_jpy and rps_jpy included — they are the spend-basis view, so on them revenue_jpy ÷ spend_jpy always equals roas, up to the rounding of roas to 2 decimals; under a non-default model their revenue_jpy/rps_jpy keep the database_statement_time_window boundary shown for roas rather than the reference_timestamp_window that presentation_hints lists for rows[*].revenue_jpy], so compare models to see e.g. how much an awareness channel gains under first_touch vs last_touch.time_decay. eachAd channelspend rowis alsogrouped carriesthrough orders`ad_channel_mapping` (purchase orders countedsite-specific byrows ouroverride ownglobal trackerrows), aov_jpy and cvr derived fromcandidate itrevenue —is withheldsummed asfrom nullmatching belowlast_touch 10session orders,channels andregardless alwaysof nullattribution_model. onCandidate ad-platformvalues /are Unattributedcontext rows;only; dothey NOTare dividenot revenue_jpypaid byattribution `conversions`and tono rebuildPaid AOV,Attribution `conversions`ROAS is the ad platform's self-reported count, a different denominator. pass filter.channel to drill into that channel's campaigns (utm_campaign) with RPS/AOV/CVR — the value must becalculated. aUnattributed channelpurchase namerevenue exactlyappears as this tool returns it, case included (e.g. 'Google Ads', 'Meta', 'Criteo', 'Google検索'),a sinceseparate therow matchand is exactexcluded andfrom aattributed lowercasetotals. slug`entry_page` returnsuses nothing.dashboard_entry_page_summary_window; 'page'country/device returnsfilters per-pageare pageviews/uniqueunsupported visitors/avgthere. time/bounce`visitor_history` plususes the page `title` (whatdashboard's thevisitor-type pagehistory IS,rule. so`revenue_status='unconfirmed'` ameans rowavailable readssignals asdo annot articleconfirm namerevenue ratherhistory: thanmonetary afields slug;and nullmonetary fordeltas pagesare withnull, nowhile visitsession sincecounts 2026-08-21remain —numeric; it does not backfill) ranked byprove pageviewspurchase (limitmeasurement defaultis 20,unconfigured. maxInternal 200;retrieval queryfailures stringsreturn stripped`isError=true`, bots excluded; each row`revenue_status='error'`, alsoand carries`revenue:null`. GSC`is_demo` Google-searchis impressions/clicks/ctr/avg_positionindependent mergedof byrevenue_status. normalizedComparisons pathare —available nullonly when the pagepreceding window has noobserved GSCtrend rowdata, and ano DIFFERENTpreceding-window denominatorfetch fromerror pageviewsoccurred, see notes). 'session_attribute' returnsand the device /first time-of-daynon-bot, (4hnon-dwell-only JST)session's /site-calendar day-of-weekdate (ISO)is /on new-vs-returningor (withbefore AOV)the /preceding countrywindow's (top-15start bydate. sessions`page` +and 'Other',`entry_page` ISO2default code,to share_pct;at frommost first-party20 sessionrows geo,and 'Unknown'report whenomitted IPcounts. unresolved)`filter.channel` breakdownsdrills ininto onecampaign call.rows. site_id is OPTIONALoptional when OAuth-authenticated. Default period is the last 30 days; pass period='today'/'7d'/'90d' or a raw day countaccepted (1-365).values Toare matchtoday, the7d, dashboard30d, exactly90d, passor start_date1-365. andExplicit end_datestart_date/end_date (YYYY-MM-DD,are inclusive calendar dates in the SITE'ssite's analysis time zone, both inclusive; end_date may be today) and optionally compare_start_date/compare_end_datetimezone. (dimension='page'Spend uses them for pageviews_change; default = the equal-length range right before); when given they replace period and period.timezone reports the site time zone. For dimension='channel'inclusive withJST dates, rows come from the dashboard's channel`ad_spend_daily.date`; RPCtrend and carry no spend/ROAS/ad-platform rows (see notes); path reflects whether the range has ad spend. `filter` only applies to dimension='channel'; `limit` only appliessession towindows dimension='page'.use Passsite optionaltimezone. countryCountry (ISO2, e.g. 'JP') and/orand device ('mobile'/'desktop'/'tablet') to scope session-derived metrics across any dimension (omit = all). For dimension='channel' you can also pass visitor_type ('new'/'returning') to split the channel table by first-time vs returning visits — the split uses the DATE-based rule (no visit by the same visitor on an earlier JST day = new), the same rule the dashboard's KPI cardfilters uses,apply NOTwhere the tracker's stored is_new_visitor flag; under it engagement fields, bot counts, ad-platformsource aggregateRPC rows,supports Unattributed,them; andunsupported revenue_breakdownaxes are omitted because their sources have no visitor_type dimension. Session rows keep ad_platform mapping metadata. Combining visitor_type with filter.channel is rejected with InvalidParams because campaign drill-down has no visitor-type axis. dimension='page' rows include pageviews_change (period-over-period % vs the previous equal-length window, nullcalled =out newin page).notes.

 ⟨36 unchanged words⟩ ,"dimension":{"enum":["channel","entry_page","visitor_history","page","session_attribute"],"type":"string"} ⟨73 unchanged words⟩ 

Return the full headline summary for a site and period in ONE call: the 5 KPIs (revenue, sessions, RPS, AOV, CVR) PLUS two, engagement KPIs (avg_durationmetrics, =current averageand dwellprevious timedaily intrends seconds,with bounce_ratecumulative =revenue, %bot-excluded single-page-exitsession sessions)count each(null with value AND thea period-over-periodnote changewhen vsthat thecount previouscannot equal-lengthbe windowretrieved), PLUS a daily revenue/sessions/conversions trendperiod_observation_status, PLUSand ad-spend availability (connected_channels, ad_spend_data_status, ad_spend_channels_in_period) and the/ Path A/B recommendation. avg_duration/bounce_rate are usefulcontext for sites with no revenue yet (engagement view). scroll_depth is the average scroll depth (%), taken per session as its deepest point then averaged; its change is a percentage-point delta. IMPORTANT: its denominator differs from avg_duration/bounce_rate — depth only covers sessionssite whoseand exitperiod. beaconRevenue-dependent landed,metrics and sessions withouttrend onerevenue are excluded rather than counted as 0. scroll_depth is null whenunless thepurchase windowmeasurement holdsis noconfirmed; depthnull signalmeans atunverified, allnot (0%zero. wouldWhen reada asconfirmed 'readperiod shallowly'has whenno thetraffic, truthperiod_observation_status is 'not measured'); depth has onlyno_observation beenand collectedcurrent sincerevenue, 2026-06-15RPS, soAOV, longerand windowsCVR are partial. Pass optional countrynull; (ISO2,observed e.g.zero 'JP')revenue and/orremains devicenumeric ('mobile'/'desktop'/'tablet')zero. toA scopemissing therevenue session-derivedhistory KPIsalone anddoes trendnot toshow that segment (omit = all); ROAS stays site-wide (ad spend has no country/device dimension).purchase Thismeasurement is what the dashboard's KPI cardsunconfigured. +When revenue-trendrevenue chartis showunverified, merged with the site'sexplain ad-spendthat context.sales Callare thisunverified firstand whenguide athe user asks 'how is my site doing?'. site_id is OPTIONAL when OAuth-authenticated (server falls back to the primarycheck site).purchase Defaultmeasurement; perioddo isnot theclaim lastit 30is days;not passset period='today'/'7d'/'90d'up. orOn a raw day count (1-365). To match the dashboard exactly, pass start_daterequired andcurrent-data end_dateretrieval (YYYY-MM-DDfailure, calendar dates in the SITE's analysistool timereturns zoneisError=true, both inclusive; end_date may berevenue_status='error', today)revenue=null and optionally compare_start_date/compare_end_date (default: the equal-length range right beforeerror_code='retrieval_failed'; start_date);never whenread givenit theyas replacezero. period,A period.timezoneprevious-window reportsRPC thefailure sitekeeps timecurrent zone,data and kpis.roas is null (see notes)makes becausecomparison_status theunavailable, dashboardwith doesprevious notKPI/trend providefields ad-attributednull. ROAS.Trend changeconversions is a percentage for revenue/sessions/RPS/AOV/avg_duration and an absolute percentage-point deltaobserved forpurchase-event CVRcount and bounce_rate. For period='today' the comparison is today-so-far vs the SAME elapsednot windowa yesterdayconfirmation (e.g.of midnight→nowrevenue vsmeasurement. midnight→same-time-yesterday),Paid soAttribution 'previous'ROAS canis readunavailable; belowkpis.roas yesterday'sremains full-daynull totalfor —response thatcompatibility isand expected,must not a discrepancy. EXCEPTION:be kpis.roas.previouspresented usesas thea fullmeasured priorROAS. JSTSessions calendarand dayengagement becausemetrics spendremain isavailable daily-grained;independently. previous_period.source_boundariesAOV and period_boundary_definitions disclose that different window. ad_spend_data_statusRPS /are ad_spend_channels_in_periodnull reflectwhen spendtheir datadenominator ACTUALLYis presentzero. inUse theoptional periodcountry (consistentISO2, withe.g. get_channel_breakdown'JP'); path_recommendation reflects whether the requested period holds any channel withand/or spend>0device (Path B ='mobile'/'desktop'/'tablet') adto spendscope connected),session-derived themetrics. samesite_id definitionis theoptional otherwhen toolsOAuth-authenticated. use.Default kpis.roasperiod is the SITE-WIDE ROAS (RS-measured revenue ÷last ad30 spenddays; overpass channelsperiod='today'/'7d'/'90d' thator havea spendraw —day Σrevenuecount ÷(1-365). Σspend,For theexact samecalendar definitiondates asin the dashboard's overallsite's ROAS;analysis thetime spend-weightedzone, aggregatepass ofstart_date get_breakdown'sand per-channelend_date, ROAS)optionally with value/previous/change (前期比 from a current + previouscomparison 2-windowdates. computation);Revenue/sessions/RPS/AOV/avg_duration itchange is null on Pathpercentage Aor /null when the period has no ad spendprior (ROASvalue is undefined with zero spend), so render it only when present. When the PREVIOUS window has no spend,zero; roas.previousCVR and roas.change are null (unknown baseline, not 0.00x) — treat that as 'no prior-period comparison',bounce_rate neverchange asis a drop frompercentage-point zero.delta.

 ⟨22 unchanged words⟩ ,"basis":{"type":"string"},"bot_excluded_count":{"type":["number","null"]},"comparison_status":{"enum":["available","unavailable"],"type":"string"},"connected_channels":{"items":{"type":"string" ⟨82 unchanged words⟩ ,"delay_bounds_assume_scheduled_jobs_operational"],"type":"object"},"is_demo":{"type":"boolean"},"kpis":{"additionalProperties":false,"properties":{" ⟨50 unchanged words⟩ false,"properties":{"change":{"type":"number"},"previous":{"type":"number"},"value":{"type":"number"}},"required":["value","previousnumber","changenull"],"type":"object"},"roas":{"anyOf":[{"additionalProperties":false,"properties":{"changeprevious":{"type":["number","null"]},"previousvalue":{"type":["number","null"]},"value":{"type":"number"}},"required":["value","previous","change"],"type":"object"},"roas":{"type":"null"}]},"rps":{"$ref":"#/properties/kpis/properties/revenue"}," ⟨183 unchanged words⟩ ,"defined_per_output_item"],"type":"object"},"period_observation_status":{"enum":["observed","no_observation"],"type":"string"},"

 ⟨12 unchanged words⟩  the sites connected to the signed-in account (each with its display name +, domain, so you can match phrases like "the production site" or "revenuescope.jp" without the user pasting atimezone, UUIDis_demo); empty when the caller is not signed in. demo_sites = ready-made sampleoperator-curated sites for trying RevenueScope, beforewith connectingtimezone yourand ownthe —site's eachis_demo isflag. aOnly fictionalcall a site witha sample data, not a realwhen customer.is_demo=true. When signed in (OAuth), prefer my_sites  ⟨17 unchanged words⟩  is empty: use a demo_sites site_id and tell the user the numbers come from a sample site,disclose notits theiris_demo own.status.

 ⟨7 unchanged words⟩ items":{"additionalProperties":false,"properties":{"is_demo":{"type":"boolean"},"label":{"type":"string"},"site_id":{"type":"string"},"timezone":{"type":"string"}},"required":["site_id","label","timezone","is_demo"],"type":"object"},"type":" ⟨9 unchanged words⟩ ,"domain":{"type":"string"},"is_demo":{"type":"boolean"},"is_primary":{"type":"boolean"},"name":{"type":"string"},"site_id":{"type":"string"},"timezone":{"type":"string"}},"required":["site_id","name","domain","is_primary","created_at","timezone","is_demo"],"type":"object"},"type": ⟨10 unchanged words⟩ 

 ⟨239 unchanged words⟩ {"type":"string"},"timezone":{"const":"Asia/Tokyo","type":"string"},"window_type":{"enum":["rolling","calendar_to_date","comparison","calendar_range"],"type":"string"}},"required" ⟨157 unchanged words⟩ 

 ⟨246 unchanged words⟩  or a raw day count (1-365). To match the dashboard exactly, pass start_date and end_date (YYYY-MM-DD, calendar dates in the SITE's analysis time zone, both inclusive; end_date may be today) and optionally compare_start_date/compare_end_date (default: the equal-length range right before start_date); when given they replace period, period.timezone reports the site time zone, and kpis.roas is null (see notes) because the dashboard does not provide ad-attributed ROAS. change is a percentage for revenue/sessions/RPS/AOV/avg_duration and an  ⟨197 unchanged words⟩ 

{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"properties":{"compare_end_date":{"$ref":"#/properties/start_date"},"compare_start_date":{"$ref":"#/properties/start_date"},"country":{"maxLength":2,"minLength":2, ⟨6 unchanged words⟩ ,"tablet"],"type":"string"},"end_date":{"$ref":"#/properties/start_date"},"period":{"anyOf":[{"const":"today ⟨21 unchanged words⟩ "30d"},"site_id":{"format":"uuid","type":"string"},"start_date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"type":"object"}

 ⟨233 unchanged words⟩ ,"roas"],"type":"object"},"notes":{"items":{"type":"string"},"type":"array"},"path_recommendation":{"enum":["A","B" ⟨75 unchanged words⟩ {"type":"string"},"timezone":{"const":"Asia/Tokyo","type":"string"},"window_type":{"enum":["rolling","calendar_to_date","comparison","calendar_range"],"type":"string"}},"required" ⟨187 unchanged words⟩