Skip to main content
POST
/
api
/
v1
/
chat
/
analyze_negative_keywords
Analyze Negative Keywords
curl --request POST \
  --url http://localhost:8000/api/v1/chat/analyze_negative_keywords \
  --header 'Authorization: Bearer <token>'
{
  "summary": {
    "recommended_negatives": [
      {
        "status": "pending",
        "is_manually_generated": true,
        "keyword": "<string>",
        "match_type": "<string>",
        "reason": "<string>",
        "campaign": {
          "id": 123,
          "name": "<string>",
          "status": "<string>",
          "channel_type": "SEARCH"
        },
        "date_regenerated": "2023-11-07T05:31:56Z",
        "date_added": "2023-11-07T05:31:56Z",
        "date_updated": "2023-11-07T05:31:56Z",
        "id": 123,
        "budget_saving": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
customer_id
integer
required
​
login_customer_id
integer | null
​
campaign_id
integer | null
​
search_terms_days
integer | null
default:1
​
search_terms_limit
integer | null
default:100
​
temperature
number
default:0.2
Required range: 0 <= x <= 1

Response

Successful Response

The schema for a response of negative keywords' analysis.

​
summary
AnalyzeNegativeKeywordsSummarySchema · object
required

The schema for a summary of negative keywords' analysis.