List ChatGPT Ads (OpenAI Conversions API) destinations
The workspace's ChatGPT Ads (OpenAI Conversions API) destinations (one per property): pixel, whether it is enabled, its connection status and recent delivery errors, plus the tracked properties a destination can still be added to.
GET /companies/{companyId}/destinations/openai
Scope read · Access Read only · Operation id destinations.list_openai
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID first.
productmetrics destinations list-openai --company-id $COMPANY_ID --jsonResponse
API response (200), shortened:
{
"data": {
"destinations": [
{
"id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
"property_name": "Example Store",
"pixel_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b"
// … 8 more fields
}
],
"properties": [
{
"property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
"property_name": "Example Store"
}
]
},
"request_id": "req_01JEAFGSK5WCM7XF2BNR0R3VBF"
}CLI output: productmetrics destinations list-openai --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Call this before destinations.set_openai to see what exists, and after it to check the status.
Path parameters
| Name | Type | Description |
|---|---|---|
companyId | string (uuid) | Your workspace id, from productmetrics whoami or properties.list (company_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 read scope; connect again and allow it.",
"details": {
"required_scope": "read"
}
},
"request_id": "req_01JQTBR3WX3J4QE23GSVGVKW7X"
}| 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 read 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. |