Send ChatGPT Ads (OpenAI Conversions API) test event
Sends one test purchase event to the property's saved ChatGPT Ads (OpenAI Conversions API) destination and answers whether the OpenAI Conversions API accepted it, with its error when not.
POST /companies/{companyId}/properties/{propertyId}/destinations/openai/test
Scope setup · Access Changes data · Operation id destinations.test_openai
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID, $PROPERTY_ID first.
productmetrics destinations test-openai \
--company-id $COMPANY_ID \
--property-id $PROPERTY_ID \
--jsonResponse
API response (200):
{
"data": {
"status": "accepted",
"request_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"error_code": "unknown",
"error_message": "Example message."
},
"request_id": "req_01JXSCGAB7A0RBTJAV5CNSAHZH"
}CLI output: productmetrics destinations test-openai --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Call after destinations.set_openai. Needs editor or admin access.
Path parameters
| Name | Type | Description |
|---|---|---|
companyId | string (uuid) | Your workspace id, from productmetrics whoami or properties.list (company_id). |
propertyId | string (uuid) | The property id, from productmetrics whoami or properties.list (property_id). |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the setup scope; connect again and allow it.",
"details": {
"required_scope": "setup"
}
},
"request_id": "req_01J3AS8A50FJRCXZK6SGG3GP3A"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the setup scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |