> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# DataForSEO: Dataforseo Labs Google Domain Rank Overview Live

> Google ranking and estimated monthly traffic for a domain, across organic and paid search. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Google ranking and estimated monthly traffic for a domain, across organic and paid search.

> [!NOTE]
>
> Tool ID: `dataforseo_dataforseo_labs_google_domain_rank_overview_live`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_dataforseo_labs_google_domain_rank_overview_live',
  {
    "target": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute dataforseo_dataforseo_labs_google_domain_rank_overview_live --input '{
  "target": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}
```

Use `deepline describe dataforseo_dataforseo_labs_google_domain_rank_overview_live --json` for the latest machine-readable contract.

## Input reference

This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.target` | `string` | Yes | — | domain required field the domain name of the target website the domain should be specified without https\:// and [www](http://www). |
| `payload.location_name` | `string` | No | — | full name of the location optional field if you use this field, you don't need to specify location\_code you can receive the list of available locations with their location\_name by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) ignore this field to get the results for all available locations example: United Kingdom |
| `payload.location_code` | `integer` | No | — | location code optional field if you use this field, you don't need to specify location\_name you can receive the list of available locations with their location\_code by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) ignore this field to get the results for all available locations example: 2840 |
| `payload.language_name` | `string` | No | — | full name of the language optional field if you use this field, you don't need to specify language\_code you can receive the list of available languages with their language\_name by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) ignore this field to get the results for all available languages example: English |
| `payload.language_code` | `string` | No | — | language code optional field if you use this field, you don't need to specify language\_name you can receive the list of available languages with their language\_code by making a separate request to the [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) ignore this field to get the results for all available languages example: en |
| `payload.ignore_synonyms` | `boolean` | No | — | ignore highly similar keywords optional field if set to true , all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: false |
| `payload.limit` | `integer` | No | — | the maximum number of returned results for domain optional field default value: 100 maximum value: 1000 |
| `payload.offset` | `integer` | No | — | offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items |
| `payload.tag` | `string` | No | — | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.",
    "properties": {
      "target": {
        "type": "string",
        "description": "domain required field the domain name of the target website the domain should be specified without https:// and www."
      },
      "location_name": {
        "type": "string",
        "description": "full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom"
      },
      "location_code": {
        "type": "integer",
        "description": "location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840"
      },
      "language_name": {
        "type": "string",
        "description": "full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English"
      },
      "language_code": {
        "type": "string",
        "description": "language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en"
      },
      "ignore_synonyms": {
        "type": "boolean",
        "description": "ignore highly similar keywords optional field if set to true , all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: false"
      },
      "limit": {
        "type": "integer",
        "description": "the maximum number of returned results for domain optional field default value: 100 maximum value: 1000"
      },
      "offset": {
        "type": "integer",
        "description": "offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items"
      },
      "tag": {
        "type": "string",
        "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response"
      }
    },
    "required": [
      "target"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Top-level response envelope for dataforseo\_dataforseo\_labs\_google\_domain\_rank\_overview\_live.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.version` | `string` | Yes | — | the current version of the API |
| `result.status_code` | `integer` | Yes | — | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
| `result.status_message` | `string` | Yes | — | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | — | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | — | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | — | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | — | array of tasks |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Top-level response envelope for dataforseo_dataforseo_labs_google_domain_rank_overview_live.",
    "properties": {
      "version": {
        "type": "string",
        "description": "the current version of the API"
      },
      "status_code": {
        "type": "integer",
        "description": "general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions"
      },
      "status_message": {
        "type": "string",
        "description": "general informational message you can find the full list of general informational messages here"
      },
      "time": {
        "type": "string",
        "description": "execution time, seconds"
      },
      "tasks_count": {
        "type": "integer",
        "description": "the number of tasks in the tasks array"
      },
      "tasks_error": {
        "type": "integer",
        "description": "the number of tasks in the tasks array returned with an error"
      },
      "tasks": {
        "type": "array",
        "description": "array of tasks",
        "items": {}
      }
    },
    "required": [
      "version",
      "status_code",
      "status_message",
      "time",
      "tasks_count",
      "tasks_error",
      "tasks"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [DataForSEO provider guide](https://deepline.com/docs/providers/dataforseo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.