View as Markdown
DataForSEO icon

DataForSEO ACTION

Get Keyword Data ID List

Retrieve the list of IDs and metadata of the completed Keywords Data tasks during the specified period. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's DataForSEO account once, then configure and run Get Keyword Data ID List from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "dataforseo-get-keyword-data-id-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    dataforseo: { authProvisionId: "apn_xxxxxxx" },
    dateTimeFrom: "Date Time From",
    dateTimeTo: "Date Time To",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Keyword Data ID List inputs
Property Type Description
dateTimeFrom Date Time From string
The start time for filtering results in the format "yyyy-mm-dd hh-mm-ss +00:00". Example: 2023-01-15 12:57:46 +00:00. If include_metadata is set to true, minimum value: a month before the current datetime. If include_metadata is set to false, minimum value: six months before the current datetime
Required
dateTimeTo Date Time To string
The finish time for filtering results in the format "yyyy-mm-dd hh-mm-ss +00:00". Example: 2023-01-15 12:57:46 +00:00
Required
includeMetadata Include Metadata boolean
If set to true, the response will include the metadata of the completed tasks
Optional
sort Sort string
The sort direction
Optional
limit Limit integer
The maximum number of results to return. Maximum: 1000
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
dataforseo-get-keyword-data-id-list
Version
0.0.3
App
DataForSEO
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes