Targeting Groups History API

The targeting groups history API allows you to query the detailed history of edits made to targeting groups during a certain period of time. To get this information, your system should make get requests to the History API. The get requests should be made to this endpoint, using your Buyer ID and required dates in the format provided in the example below.

# <dsp-id> is your numeric BidSwitch Buyer ID, and <tgroup-id> is the numeric
# targeting group ID, for example 1111
# <tgroup-id> is an optional parameter, without it you will get all the change
# history for the requested dates rather than tha data on one specific group

https://my.bidswitch.com/api/history/dsp/<dsp-id>/tgroups?start_date=2021-11-13&end_date=2022-01-12&tgroup=<tgroup-id>

Please refer to the API Authorization section for details on how to authenticate with the API.

History Fields

History API Fields

Field

Type

Description

id

integer

The numeric identifier of the change made

action

string

Represents the action taken, for example update or create

object_type

string

Represents the object that has been edited, a targeting group in this case

object_id

integer

The numeric identifier of the edited targeting group

datetime_created

string

The date and UTC time when the change was made

user

string

The ID of the user who made the change

diff

array of objects

Represents the actual change as a key that represents the edited setting and a set of changed values

Diff Object

Field

Type

Description

key

string

Represents the edited setting

values

array of arrays

Represents two sets of parameters related to the change made: the initial configuration and the resulting one

Example Change Report

{
 "id":111111,
 "action":"update",
 "object_type":"tgroup",
 "object_id":1111,
 "datetime_created":"2020-01-01T13:00:35.146164Z",
 "user":"jane_doe",
 "diff":[
   {
     "key":"is_paused",
     "values":[
       true,
       false
      ]
    }
  ]
},