Keywords

GET

https://api.data.v4.marketing/v1/google/ads/keywords

Retrieve Google Ads keyword data with detailed performance metrics.

This endpoint provides keyword-level insights including match type, ad group and campaign associations, and performance indicators.

Dimensions Available:

Keyword text, match type, ad group criterion

Ad group ID/name/status/type

Campaign ID/name/group, bidding strategy type, ad ID

Metrics: impressions, clicks, cost, conversions, conversions value, all conversions

Date

Limitations:

Maximum 5000 records per page

Supports date filtering via createdStart and createdEnd (ISO 8601 format)

Supports sorting via orderBy and orderDirection (ASC/DESC)

Filters:

workspaceId (required)

organizationId (optional)

userId (optional)

integrationName (optional)

createdStart (optional)

createdEnd (optional)

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

Parâmetros de Consulta

Respostas

🟢200Sucesso

application/json

Successful response

Body

🟠400400

🔴500500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/google/ads/keywords?workspaceId=workspace_123&organizationId&userId&integrationName&createdStart=2024-01-01T00:00:00Z&createdEnd=2024-12-31T23:59:59Z&page&limit&orderBy&orderDirection' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "data": [
        {
            "date": "2019-08-24",
            "keyword_text": "string",
            "keyword_match_type": "string",
            "ad_group_criterion": "string",
            "ad_group_type": "string",
            "ad_group_status": "string",
            "ad_group_name": "string",
            "ad_group_id": "string",
            "ad_id": "string",
            "ad_group_campaign": "string",
            "campaign_bidding_strategy_type": "string",
            "campaign_id": "string",
            "campaign_name": "string",
            "campaign_group": "string",
            "impressions": 0,
            "clicks": 0,
            "cost": 0,
            "conversions": 0,
            "conversions_value": 0,
            "all_conversions": 0,
            "workspace_id": "string",
            "organization_id": "string",
            "user_id": "string",
            "document_id": "string",
            "integration_name": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modificado em 2025-12-02 02:02:19