U.S. Multi-State Privacy message data

post https://portal.sourcepoint.com/api/external/v1/reports/usnat/dashboard-v2-messages/{periodFilter}

Returns message data for properties that have implemented U.S. Multi-State Privacy.

Include your API key in the provided Header field under AUTHORIZATION in the right-hand pane before trying your request.

In addition to the API key, you will also need to include startDate, endDate, and siteId in your request.

Path Params

periodFilter

string

required

Daily: The maximum duration of this period is 31 days between the startDate and endDate
Weekly: A week is a period of 7 days that starts on a Monday and ends on a Sunday. If the requested startDate is not a Monday, Sourcepoint will backdate the reporting period to the Monday for the week in its reporting aggregation.
Monthly: A month begins on the first day of that month. If the requested startDate is not the first day of the month, Sourcepoint will backdate the reporting period to the first day of the month in its reporting aggregation.

Body Params

startDate

string

required

Start date for the periodization. Format YYYY-MM-DD

endDate

string

required

End date for the periodization. Format YYYY-MM-DD

siteId

array of strings

required

Array of property IDs in the Sourcepoint portal that will be included in the report data.

siteId*

geo

array of strings

Array of alpha-2 country codes (ISO 3166-1) that will be included in the report data. Preset regions (EU, EEA, etc...) is not permitted. If geo property is omitted then all countries and regions will be included in the report data.

geo

state

array of strings

Array of alpha-2 state codes (ISO 3166-2:US) that will be included in the report data. If state property is omitted then all US states will be included in the report data.

state

device

array of strings

Array of devices that will be included in the report data. If device property is omitted then all devices will be included in report data.

device

browser

array of strings

Array of browsers that will be included in the report data. If browser property is omitted then all browsers will be included in report data.

browser

array of strings

Array of operating systems that will be included in the report data. If os property is omitted then all operating systems will be included in report data.

breakdownBy

array of strings

Array of different parameters that can be selected to breakdown/organize the returned results. Options include geo, state, message ID (msg_id), operating system (ua_os), device (ua_device), browser (ua_browser)

breakdownBy

Responses

Response body

object

performanceData

object

Ignore. For internal troubleshooting.

total

integer

messagesResults

integer

results

array of objects

results

object

ymd

string

Year, month and day. Returned only for Daily periodization

geo

string

Geographic region to which the results pertain. Returned when request uses geo in the breakdownBy parameter

state

string

US state to which the results pertain. Returned when request uses state in the breakdownBy parameter

ua_os

string

Operating system type to which the results pertain. Returned when request uses ua_os in the breakdownBy parameter

ua_device

string

Device type to which the results pertain. Returned when request uses ua_device in the breakdownBy parameter

ua_browser

string

Browser type to which the results pertain. Returned when request uses ua_browser in the breakdownBy parameter

site_id

string

Property ID within the Sourcepoint portal

property_name

string

Domain reported upon

Message Actions: Total

number

Total number of end-user actions

Message Actions: Sell Opted-in

number

Total number of actions on messages whose latest choice included an opt into the sale of personal information privacy choice

Message Actions: Sell Opted-out

number

Total number of actions on messages whose latest choice included an opt out of the sale of personal information privacy choice

Message Actions: Share Opted-in

number

Message Actions: Share Opted-out

number

Message Actions: Sensitive Data Opted-in

number

Total number of actions on messages whose latest choice included an opt into sensitive data privacy choices

Message Actions: Sensitive Data Opted-out

number

Total number of actions on messages whose latest choice included an opt out of sensitive data privacy choices

Message Actions: GPC Enabled

number

Total number of actions on messages whose latest choice was made using a browser with the Global Privacy Control setting enabled

Message Actions: GPC Disabled

number

Total number of actions on messages whose latest choice was made using a browser with the Global Privacy Control setting disabled

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://portal.sourcepoint.com/api/external/v1/reports/usnat/dashboard-v2-messages/daily \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Success

401API key is missing or invalid