GET PUBLISH INFO

Get publish information about the EyeLevel conversation flow associated with the given API key

QUERY

GET https://api.eyelevel.ai/v1/partner/publish/:apiKey/:id

Path Parameters

{
    "publish": {
        "adId":       "STRING",
        "adSetId":    "STRING",
        "campaignId": "STRING",
        "qrLinks":    {
            "png@200":  "STRING",
            "png@500":  "STRING",
            "png@1000": "STRING",
            "svg":      "STRING",
        },
        platforms: [
            "ENUMERATED STRING"
        ],
        "url":        "STRING",
    }
}

Response

{
    "publish": {
        "adId":       "STRING",
        "adSetId":    "STRING",
        "campaignId": "STRING",
        "qrLinks":    {
            "png@200":  "STRING",
            "png@500":  "STRING",
            "png@1000": "STRING",
            "svg":      "STRING",
        },
        platforms: [
            "ENUMERATED STRING"
        ],
        "url":        "STRING",
    }
}

adId

The ad identifier where the chat flow was published.

adSetId

The ad set identifier where the chat flow was published.

campaignId

The campaign identifier where the chat flow was published.

platforms

The marketing channels where the chat flow has been published. The values will be one of:

  • web - for websites

  • linkedin - for LinkedIn ads

  • instagram - for Instagram web ads

  • email - for email marketing

  • gads - for Google search ads

  • fbads - for Facebook web ads

  • facebook - for Facebook platform Messenger ads (includes Instagram)

  • youtube - for YouTube ads

  • fbpage - for Facebook Pages

png@200

The URL for the 200 x 200 pixel hosted QR code image. The URL is valid for 24 hours.

png@500

The URL for the 500 x 500 pixel hosted QR code image. The URL is valid for 24 hours.

png@1000

The URL for the 1000 x 1000 pixel hosted QR code image. The URL is valid for 24 hours.

svg

The URL for the hosted QR code image. The URL is valid for 24 hours.

url

The URL that can be used to launch the chat flow.

Last updated