Skip to main content

Get Events

  • Updated

Use this endpoint to get all events for an ad account.

Request

End Point https://business.newsbreak.com/business-api/v1/event/getList/{adAccountId}

Method GET

Header

Field Required Data Type Description
Access-Token Y string Authorized access token. 

Path Variable

Field Required Data Type Description
adAccountId Y string ID of the ad account of the events.

Request Parameters

Field Required Data Type Description
os N enumerate[] Filter events by operation system. Available values: IOS, ANDROID. Use os= to filter for web events. Do not attach this parameter if you want to get all events regardless of operation system.

Example

curl --location --request GET 'https://business.newsbreak.com/business-api/v1/event/getList/123456789?os=' \
-H 'Content-Type: application/json' \
-H 'Access-Token:{{Access-Token}}'
 

Response

Response Parameters

Field Data Type Description
code int Status code, see Return Codes.
errMsg string Error message when code!=0.
data object Response object.
└── list object[] Each row is an event.
    └── id string Event tracking ID to be used in ad set.
    └── name string Event tracking name.
    └── orgId string Organization ID.
    └── type enumerate Event type. Available values: PIXEL, POSTBACK.
    └── eventType string The event type of the tracking event.
    └── eventParams string[] Attachable parameters of the tracking event.
    └── url string Url of the tracking event.
    └── os enumerate The operation system of this event if it's an APP event.
    └── mobilePartner enumerate Mobile partner of this event if it's an APP event. Available values: APPSFLYER, ADJUST.
    └── clickTrackingUrl string Click tracking url of this event if it's an APP event.
    └── impressionTrackingUrl string Impression tracking url of this event if it's an APP event.
    └── version int The version of the event.
    └── createTime int The creation timestamp of the event.
    └── updateTime int The update timestamp of the event.

Example

{
    "code": 0,
    "data": {
        "list": [
            {
                "name": "test for pixel",
                "type": "PIXEL",
                "eventType": "conversion_event",
                "url": "https://www.google.com",
                "orgId": "123456789",
                "id": "987654321",
                "version": 0,
                "createTime": 1692907307,
                "updateTime": 1696880654
            }
        ]
    }
}
 

Related articles