Use wide Search Console API integration

With Ants & Apps platform you can connect Search Console API with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • searchanalytics

    • Query your data with filters and parameters that you define

      This action query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.

      POSTWebmastersSearchanalyticsQuery

      Request parameters

      • siteUrl*string

        The site's URL, including protocol. For example: http://www.example.com/

      Request body

      • aggregationTypestring

        [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.

      • dimensionFilterGroupsarray

        [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.

      • dimensionsarray

        [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.

      • endDatestring

        [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.

      • rowLimitinteger

        [Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).

      • searchTypestring

        [Optional; Default is "web"] The search type to filter for.

      • startDatestring

        [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.

      • startRowinteger

        [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.

  • sitemaps

    • Retrief information about a specific sitemap

      This action retrieves information about a specific sitemap.

      GETWebmastersSitemapsGet

      Request parameters

      • feedpath*string

        The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml

      • siteUrl*string

        The site's URL, including protocol. For example: http://www.example.com/

    • List the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request)

      This action lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

      GETWebmastersSitemapsList

      Request parameters

      • siteUrl*string

        The site's URL, including protocol. For example: http://www.example.com/

      • sitemapIndexstring

        A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml

    • Submit a sitemap for a site

      This action submits a sitemap for a site.

      PUTWebmastersSitemapsSubmit

      Request parameters

      • feedpath*string

        The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml

      • siteUrl*string

        The site's URL, including protocol. For example: http://www.example.com/

    • Delete a sitemap from this site

      This action deletes a sitemap from this site.

      DELETEWebmastersSitemapsDelete

      Request parameters

      • feedpath*string

        The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml

      • siteUrl*string

        The site's URL, including protocol. For example: http://www.example.com/

  • sites

    • Retrief information about specific site

      This action retrieves information about specific site.

      GETWebmastersSitesGet

      Request parameters

      • siteUrl*string

        The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

    • List the user's Search Console sites

      This action lists the user's Search Console sites.

      GETWebmastersSitesList
    • Add a site to the set of the user's sites in Search Console

      This action adds a site to the set of the user's sites in Search Console.

      PUTWebmastersSitesAdd

      Request parameters

      • siteUrl*string

        The URL of the site to add.

    • Remove a site from the set of the user's Search Console sites

      This action removes a site from the set of the user's Search Console sites.

      DELETEWebmastersSitesDelete

      Request parameters

      • siteUrl*string

        The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.