Noizu.Google.Api.SearchConsole.SearchAnalytics (Noizu Google v0.2.3)

Copy Markdown View Source

Google Search Console Search Analytics resource.

REST: POST sites/{siteUrl}/searchAnalytics/query

Docs: https://developers.google.com/webmaster-tools/v1/searchanalytics/query

Summary

Types

opts()
result()

Functions

query(site_url, body, opts \\ [])

POST sites/{siteUrl}/searchAnalytics/query.

Types

opts()

@type opts() :: keyword() | map()

result()

@type result() :: {:ok, term()} | {:error, Noizu.Google.Error.t()}

Functions

query(site_url, body, opts \\ [])

@spec query(String.t(), map(), opts()) :: result()

POST sites/{siteUrl}/searchAnalytics/query.

Request body (map)

Required:

  • :startDate / "startDate" — YYYY-MM-DD
  • :endDate / "endDate" — YYYY-MM-DD

Common optional fields: dimensions, rowLimit, startRow, dimensionFilterGroups, aggregationType, dataState, type (web/image/video/news/discover/googleNews).

Example

Noizu.Google.Api.SearchConsole.SearchAnalytics.query(
  "https://example.com/",
  %{
    startDate: "2026-01-01",
    endDate: "2026-01-31",
    dimensions: ["query", "page"],
    rowLimit: 25
  },
  client: client
)