GET /metrics-by-country

Servers

Query parameters

Name Type Required Description
limit Integer No

The number of results to return.

volume_mode String No

The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value.

Possible values:

  • "average"
  • "monthly"

Default value: "monthly"

protocol String No

The protocol of your target.

Possible values:

  • "both"
  • "http"
  • "https"

Default value: "both"

output String No

The output format.

Possible values:

  • "csv"
  • "json"
  • "xml"
  • "php"
target String Yes

The target of the search: a domain or a URL.

mode String No

The scope of the search based on the target you entered.

Possible values:

  • "exact"
  • "domain"
  • "prefix"
  • "subdomains"

Default value: "subdomains"

date String Yes

A date to report metrics on in YYYY-MM-DD format.

offset Integer No

[Deprecates on 31 May 2024] Returned results will start from the row indicated in the offset value.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.