API Reference

U.S. Multi-State Privacy pageview data

post
https://portal.sourcepoint.com/api/external/v1/reports/usnat/dashboard-v2-pv-users/

Returns pageview 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
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.
Allowed:
Body Params
string
required

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

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
os
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.

os
breakdownBy
array of strings

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

breakdownBy
Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 10 months ago