Default request referring to version v3 of the Webmaster Tools API. This contains the host and root path used as a starting point for constructing service requests.

Represents the entirety of the methods and resources available for the Webmaster Tools API service.

Information about the various content types in the sitemap.

See: wmxSitemapContent smart constructor.

Creates a value of WmxSitemapContent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wscIndexed
• wscType
• wscSubmitted

The number of URLs from the sitemap that were indexed (of the content type).

The specific type of content in this sitemap. For example: web.

The number of URLs in the sitemap (of the content type).

Creates a value of APIdimensionFilterGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• afgFilters
• afgGroupType

Additional details about the URL, set only when calling get().

See: urlSampleDetails smart constructor.

Creates a value of URLSampleDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usdLinkedFromURLs
• usdContainingSitemaps

A sample set of URLs linking to this URL.

List of sitemaps pointing at this URL.

The crawl error category. For example: authPermissions

Number of errors per day for a specific error type (defined by platform and category).

See: urlCrawlErrorCountsPerType smart constructor.

Creates a value of URLCrawlErrorCountsPerType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucecptPlatform
• ucecptEntries
• ucecptCategory

The general type of Googlebot that made the request (see list of Googlebot user-agents for the user-agents used).

The error count entries time series.

The crawl error type.

The user agent type (platform) that made the request. For example: web

Creates a value of APIDataRow with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• adrImpressions
• adrKeys
• adrCtr
• adrClicks
• adrPosition

Creates a value of APIdimensionFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• afOperator
• afDimension
• afExpression

The user agent type (platform) that made the request. For example: web

The crawl error category. For example: authPermissions

An entry in a URL crawl errors time series.

See: urlCrawlErrorCount smart constructor.

Creates a value of URLCrawlErrorCount with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucecCount
• ucecTimestamp

The error count at the given timestamp.

The date and time when the crawl attempt took place, in RFC 3339 format.

The user agent type (platform) that made the request. For example: web. If not specified, returns results for all platforms.

A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.

See: searchAnalyticsQueryResponse smart constructor.

Creates a value of SearchAnalyticsQueryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• saqrRows
• saqrResponseAggregationType

A list of rows grouped by the key values in the order given in the query.

How the results were aggregated.

The crawl error category. For example: authPermissions

List of crawl error samples.

See: urlCrawlErrorsSamplesListResponse smart constructor.

Creates a value of URLCrawlErrorsSamplesListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uceslrURLCrawlErrorSample

Information about the sample URL and its crawl error.

A time series of the number of URL crawl errors per error category and platform.

See: urlCrawlErrorsCountsQueryResponse smart constructor.

Creates a value of URLCrawlErrorsCountsQueryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucecqrCountPerTypes

The time series of the number of URL crawl errors per error category and platform.

Contains information about specific crawl errors.

See: urlCrawlErrorsSample smart constructor.

Creates a value of URLCrawlErrorsSample with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucesResponseCode
• ucesURLDetails
• ucesLastCrawled
• ucesPageURL
• ucesFirstDetected

The HTTP response code, if any.

Additional details about the URL, set only when calling get().

The time when the URL was last crawled, in RFC 3339 format.

The URL of an error, relative to the site.

The time the error was first detected, in RFC 3339 format.

Contains detailed information about a specific URL submitted as a sitemap.

See: wmxSitemap smart constructor.

Creates a value of WmxSitemap with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wsContents
• wsPath
• wsIsSitemapsIndex
• wsLastSubmitted
• wsWarnings
• wsLastDownloaded
• wsIsPending
• wsType
• wsErrors

The various content types in the sitemap.

The url of the sitemap.

If true, the sitemap is a collection of sitemaps.

Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).

Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.

Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).

If true, the sitemap has not been processed.

The type of the sitemap. For example: rssFeed.

Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.

List of sitemaps.

See: sitemapsListResponse smart constructor.

Creates a value of SitemapsListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• slrSitemap

Contains detailed information about a specific URL submitted as a sitemap.

Creates a value of SearchAnalyticsQueryRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• saqrAggregationType
• saqrRowLimit
• saqrEndDate
• saqrSearchType
• saqrDimensionFilterGroups
• saqrStartDate
• saqrDimensions

Optional; Default is "auto"

How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. Note: If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.

Optional; Default is 1000

The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).

Required

End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.

Optional; Default is "web"

The search type to filter for.

Optional

Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case-sensitive). You can filter by a dimension without grouping by it.

Required

Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.

Optional

Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.

The user agent type (platform) that made the request. For example: web

List of sites with access level information.

See: sitesListResponse smart constructor.

Creates a value of SitesListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• slrSiteEntry

Contains permission level information about a Webmaster Tools site. For more information, see Permissions in Webmaster Tools.

Contains permission level information about a Webmaster Tools site. For more information, see Permissions in Webmaster Tools.

See: wmxSite smart constructor.

Creates a value of WmxSite with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wsPermissionLevel
• wsSiteURL

The user's permission level for the site.

The URL of the site.

The crawl error category. For example: serverError. If not specified, returns results for all categories.