# Setting Live ‘DataForSEO Trends Subregion Interests’ Tasks

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/dataforseo_trends/subregion_interests/live`

**Tags:** DataForSEO

Where interest in a keyword is concentrated, broken down by subregion within `location_code`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. For who rather than where, `post_dataforseo_keywords_trends_demography_live`.

### Pricing reference

- Metering: Reported response cost.
- Reference request estimate: USD 0.0024.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>keywords</em><br><strong>required field</strong><br>the maximum number of keywords you can specify: 5<br>avoid symbols and special characters (e.g., UTF symbols, emojis);<br>specifying non-Latin characters, you’ll get data for the countries where they are used<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>full name of search engine location</em><br>optional field<br>if you don't use this field, you will recieve global results<br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_name</code> belongs to;</strong><br>example:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>search engine location code</em><br>optional field<br>if you don't use this field, you will recieve global results<br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_code</code> belongs to;</strong><br>example:<br><code class=\"long-string\">2840</code>"
          },
          "type": {
            "type": [
              "string",
              "null"
            ],
            "description": "type of element"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>"
          },
          "time_range": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response"
          }
        },
        "example": [
          {
            "keywords": [
              "rugby",
              "cricket"
            ],
            "date_from": "2023-01-01",
            "date_to": "2024-01-01",
            "type": "web",
            "location_name": "United States"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keywords": [
        "rugby",
        "cricket"
      ],
      "date_from": "2023-01-01",
      "date_to": "2024-01-01",
      "type": "web",
      "location_name": "United States"
    }
  ]
}
```

## Responses

### 200 — Successful operation

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo"
    }
  ]
}
```

### 400 — The request could not be processed. Check the request parameters.

### 401 — A valid Felo API key is required.

### 402 — The request cannot proceed because a billing requirement is not met.

### 403 — The account is not permitted to perform this operation.

### 429 — A request or spending limit has been reached.

### 502 — The service could not complete the request.

### 503 — The API or billing service is temporarily unavailable.

### 504 — The service timed out while processing the request.

### default — Error response; upstream passthrough responses may use provider formats

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AbsoluteItems

`#/components/schemas/Response36Afe1097B20_AbsoluteItems`

```json
{
  "type": "object",
  "properties": {
    "geo_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>location identifier</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_id</code> <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>US-NY</code>"
    },
    "geo_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>location name</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_name</code> <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>Andorra</code>"
    },
    "values": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>contains data on relative keyword popularity by country or region</em>"
    }
  }
}
```

### Response36Afe1097B20_BaseKeywordDataDataforseoTrendsItem

`#/components/schemas/Response36Afe1097B20_BaseKeywordDataDataforseoTrendsItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of element"
    },
    "position": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>the alignment of the element</em><br>can take the following values: <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, etc."
    },
    "keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>keywords in a POST array</em>"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "dataforseo_trends_graph": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsDataforseoTrendsGraphElementItem",
      "subregion_interests": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem",
      "demography": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsDemographyElementItem"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "the current version of the API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "general status code\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "general informational message\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array returned with an error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "task identifier\nunique task identifier in our system in the UUID format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "informational message of the task\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "number of elements in the result array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL path"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "contains the same parameters that you specified in the POST request"
    }
  }
}
```

### Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem

`#/components/schemas/Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseKeywordDataDataforseoTrendsItem"
    },
    {
      "type": "object",
      "properties": {
        "interests": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsInfo"
              }
            ]
          },
          "description": "<em>subregional keyword popuarity data for each specified term</em>"
        },
        "interests_comparison": {
          "type": [
            "object",
            "null"
          ],
          "oneOf": [
            {
              "$ref": "#/components/schemas/Response36Afe1097B20_InterestsComparison"
            }
          ],
          "description": "<em>comparison of data on subregional keyword popularity for the specified parameters</em><br>if you specified a single keyword, the value will be <code>null</code>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoTrendsinterestsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>relevant keyword</em><br>the data included in the <code>values</code> element is based on this keyword"
    },
    "values": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsValuesInfo"
          }
        ]
      },
      "description": "<em>contains data on relative keyword popularity by country or region</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoTrendsinterestsValuesInfo

`#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsValuesInfo`

```json
{
  "type": "object",
  "properties": {
    "geo_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>location identifier</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_id</code> <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>US-NY</code>"
    },
    "geo_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>location name</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_name</code> <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>Andorra</code>"
    },
    "value": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>relative keyword popularity rate in a given location</em><br>represents location-specific keyword popularity rate over the specified time range;<br>using this <code>value</code> you can understand how popular a keyword is in one location compared to another location;<br>calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100);<br>a value of <code>100</code> is the highest popularity for the term<br>a value of <code>50</code> means that the term is half as popular<br>a value of <code>0</code> means there was not enough data for this term"
    }
  }
}
```

### Response36Afe1097B20_InterestsComparison

`#/components/schemas/Response36Afe1097B20_InterestsComparison`

```json
{
  "type": "object",
  "properties": {
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AbsoluteItems"
          }
        ]
      },
      "description": "<em>contains keyword popularity and related data</em>"
    },
    "absolute_items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AbsoluteItems"
          }
        ]
      },
      "description": "<em>keyword popularity rates across all locations</em><br>values in this array represent percentages relative to the maximum value across all locations"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo"
              }
            ]
          },
          "description": "<em>array of tasks</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>keywords in a POST array</em>"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of element"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>the number of results returned in the <strong><code>items</code></strong> array</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem"
          }
        ]
      },
      "description": "<em>contains keyword popularity and related data</em>"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo"
              }
            ]
          },
          "description": "<em>array of results</em>"
        }
      }
    }
  ]
}
```