# Get Keyword Data ID List — DataForSEO

> Retrieve the list of IDs and metadata of the completed Keywords Data tasks during the specified period. See the documentation

- Key: `dataforseo-get-keyword-data-id-list`
- Type: Action (Read-only)
- Version: 0.0.3
- App: DataForSEO (`dataforseo`) — https://pipedream.com/apps/dataforseo.md
- This page (HTML): https://pipedream.com/apps/dataforseo/actions/get-keyword-data-id-list
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/dataforseo/actions/get-keyword-data-id-list/get-keyword-data-id-list.mjs

## Description

Retrieve the list of IDs and metadata of the completed Keywords Data tasks during the specified period. [See the documentation](https://docs.dataforseo.com/v3/keywords_data/id_list/?bash)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `dateTimeFrom` | `string` | Yes | 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 |
| `dateTimeTo` | `string` | Yes | 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 |
| `includeMetadata` | `boolean` | No | If set to true, the response will include the metadata of the completed tasks |
| `sort` | `string` | No | The sort direction |
| `limit` | `integer` | No | The maximum number of results to return. Maximum: 1000 |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "dataforseo",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "dataforseo-get-keyword-data-id-list",
  arguments: {
    dateTimeFrom: "Date Time From",
    dateTimeTo: "Date Time To",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "dataforseo-get-keyword-data-id-list",
    "configured_props": {
      "dataforseo": { "authProvisionId": "apn_xxxxxxx" },
      "dateTimeFrom": "Date Time From",
      "dateTimeTo": "Date Time To"
    }
  }'
```

---

- App: https://pipedream.com/apps/dataforseo.md · All apps: https://pipedream.com/apps