Get Custom Conversions

Get custom conversions for a campaign

POST /meta/get_custom_conversions

Get Custom Conversions

cURL

curl --request POST \
  --url https://public.plai.io/meta/get_custom_conversions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "pixelId": "<string>",
  "campaignType": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "customConversions": [
      {
        "name": "<string>",
        "value": "<string>",
        "is_custom_event": true
      }
    ],
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

pixelId · string · required

Facebook Pixel ID, you can get the pixel id from here

campaignType · string · required

Campaign Type, Supported values are: CONVERSIONS, OUTCOME_SALES

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results Object

success · boolean

Indicates whether the specific operation or API action was successful.

customConversions · object[]

Show Custom Conversions Object

name · string

Custom conversion name

value · string

Custom conversion value, this value is used in create campaign api, here, for conversion and sales goal.

is_custom_event · boolean

Whether the conversion is a custom event

error · string

Error string if something went wrong