Get Campaign Optimization History

This endpoint retrieves the full optimization history of a campaign. It includes detailed logs of changes made during both audience and creative optimizations — such as which segments were paused, what assets were updated, and when these changes occurred.

POST /optimize_me/get_campaign_optimization_history

Get Campaign Optimization History

cURL

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

200

{
  "success": true,
  "results": {
    "success": true,
    "campaign": {
      "campaignId": "<string>",
      "campaignName": "<string>",
      "startDate": 123,
      "timestamp": 123,
      "optimizationStatus": "<string>",
      "platform": "<string>",
      "history": [
        {
          "adId": "<string>",
          "headlines": [
            {
              "newText": "<string>",
              "oldText": "<string>"
            }
          ],
          "primaryTexts": [
            {
              "newText": "<string>",
              "oldText": "<string>"
            }
          ],
          "images": [
            {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "id": "<string>"
            }
          ],
          "adSetId": "<string>",
          "timestamp": 123,
          "lastUpdate": {
            "_seconds": 123,
            "_nanoseconds": 123
          }
        }
      ]
    },
    "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.

campaignId · string · required

Campaign ID

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.

campaign · object

Show Campaign Object

campaignId · string

The unique identifier for the campaign.

campaignName · string

The name of the campaign.

startDate · number

The start date of the campaign.

timestamp · number

Timestamp of the optimization.

optimizationStatus · string

Optimization status of the campaign.

platform · string

The platform of the campaign.

history · object[]

Show History Object

adId · string

The ad ID.

Example: "1234567890"

headlines · object[]

Show Headlines Object

newText · string

The new headline text.

oldText · string

The old headline text.

primaryTexts · object[]

Show Primary Texts Object

newText · string

The new primary text.

oldText · string

The old primary text.

images · object[]

Show Images Object

url · string

The url of the image.

width · number

The width of the image.

height · number

The height of the image.

id · string

The id of the image.

adSetId · string

The ad set id.

timestamp · number

The timestamp of the optimization.

lastUpdate · object

Show Last Update Object

_seconds · number

The seconds of the last update.

_nanoseconds · number

The nanoseconds of the last update.

error · string

Error string if something went wrong