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

# Pinterest Topic

> Get the monthly search count and related topics of a Pinterest idea page.

# Pinterest Topic

Size up a Pinterest topic before you build content for it. For each idea page you get the monthly search count Pinterest reports and the narrower topics it suggests underneath, such as the styles, occasions and materials people combine with the main idea. It works as keyword research for Pinterest: compare demand across topics, find long-tail angles, and plan boards around what people actually search for.

```json theme={"dark"}
{
  "urls": [
    "https://www.pinterest.com/ideas/home-decor/935249274030/"
  ]
}
```

Provide Pinterest idea page URLs in urls, using /ideas/{topic}/{id}/. Each topic returns one row with its monthly search count and narrower topics, and each row costs 0.5 credits.

## Standard Result Fields

Task results use the stable SocQ fields below. Source-specific field names and formats are normalized without inferring or enriching values that the source did not provide. To request a smaller field set, use `fields` for MCP queries, `_result_fields` for typed tools, or `--result-fields` in the CLI. Declared fields remain present when their value is `null`.

| Field | Type | Nullable | Description |
| - | - | - | - |
| `id` | `string` | Yes | Unique identifier for this result item. |
| `platform` | `string` | No | Platform the result belongs to, such as `instagram` or `linkedin`. |
| `resource` | `string` | No | SocQ resource represented by the result, such as `videos` or `comments`. |
| `type` | `string` | No | Category of the result item, such as `video`, `post`, or `comment`. |
| `url` | `string` | Yes | URL of the topic's idea page. |
| `published_at` | `string` | Yes | Time the source item was published, in ISO 8601 format when available. |
| `collected_at` | `string` | No | Time SocQ collected or processed this result, in ISO 8601 format. |
| `name` | `string` | Yes | Name of the Pinterest topic. |
| `search_count` | `integer` | Yes | Monthly search count Pinterest reports for the topic. |
| `updated_at` | `string` | Yes | Time Pinterest last refreshed the topic, in ISO 8601 format. |
| `related_topics` | `array<object>` | Yes | Narrower topics Pinterest suggests under this one. |
| `related_topics.name` | `string` | Yes | Full name of the narrower topic. |
| `related_topics.label` | `string` | Yes | Short label shown for the narrower topic, such as `DIY`. |
| `related_topics.url` | `string` | Yes | URL of the narrower topic's idea page. |

The following example shows the response format for a completed task. Actual data depends on your query.

## Completed Task Response

```json theme={"dark"}
{
  "code": 200,
  "data": {
    "task_id": "example-pinterest-topic",
    "status": "succeeded",
    "public_id": "pinterest/topic",
    "result_count": 1,
    "credits_amount": 0.5,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "topic",
      "schema_version": "1.0",
      "items": [
        {
          "id": "935249274030",
          "platform": "pinterest",
          "resource": "topic",
          "type": "topic",
          "url": "https://www.pinterest.com/ideas/home-decor/935249274030/",
          "published_at": null,
          "collected_at": "2026-11-17T14:41:09.727864Z",
          "name": "home decor",
          "search_count": 3548161,
          "updated_at": "2026-11-04T20:23:19Z",
          "related_topics": [
            {
              "name": "Home Decor Ideas",
              "label": "Ideas",
              "url": "https://www.pinterest.com/ideas/home-decor-ideas/897707546790/"
            },
            {
              "name": "Diy Home Decor",
              "label": "Diy",
              "url": "https://www.pinterest.com/ideas/diy-home-decor/944798509834/"
            },
            {
              "name": "Earthy Cottage Home Decor",
              "label": "Earthy Cottage",
              "url": "https://www.pinterest.com/ideas/earthy-cottage-home-decor/943886138925/"
            },
            {
              "name": "Christmas Home Decor",
              "label": "Christmas",
              "url": "https://www.pinterest.com/ideas/christmas-home-decor/935502310471/"
            },
            {
              "name": "Thrifted Home Decor",
              "label": "Thrifted",
              "url": "https://www.pinterest.com/ideas/thrifted-home-decor/898181173829/"
            }
          ]
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/pinterest/topic
openapi: 3.1.0
info:
  title: SocQ Agent API
  version: v1-87892a6484c2
  description: Asynchronous social data API generated from the SocQ Capability Registry.
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/pinterest/topic:
    post:
      tags:
        - pinterest
      summary: Pinterest Topic API
      description: Collect the search volume and related topics of Pinterest idea pages.
      operationId: socq_pinterest_topic
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                callback_url:
                  type: string
                  format: uri
                urls:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
                  description: Public profile or content URLs.
              required:
                - urls
              description: >-
                Provide Pinterest idea page URLs in urls, using
                /ideas/{topic}/{id}/. Each topic returns one row with its
                monthly search count and the narrower topics Pinterest suggests
                under it.
      responses:
        '200':
          description: Task accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
        '422':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    AgentSubmitResponse:
      type: object
      properties:
        code:
          type: integer
          const: 200
        data:
          type: object
          properties:
            task_id:
              type: string
            status:
              type: string
            created_time:
              type:
                - string
                - 'null'
          required:
            - task_id
            - status
    AgentValidationErrorResponse:
      type: object
      properties:
        code:
          type: integer
          const: 422
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            details:
              type: object
          required:
            - message
            - type
      required:
        - code
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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