The DCM/DFA Reporting and Trafficking API v3.2 is deprecated and will be sunset on August 31st, 2019. All users must migrate to a newer API version by that date.

Sites: list

Requires authorization

Retrieves a list of sites, possibly filtered. This method supports paging. Try it now.


HTTP request



Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
acceptsInStreamVideoPlacements boolean This search filter is no longer supported and will have no effect on the results returned.
acceptsInterstitialPlacements boolean This search filter is no longer supported and will have no effect on the results returned.
acceptsPublisherPaidPlacements boolean Select only sites that accept publisher paid placements.
adWordsSite boolean Select only AdWords sites.
approved boolean Select only approved sites.
campaignIds long Select only sites with these campaign IDs.
directorySiteIds long Select only sites with these directory site IDs.
ids long Select only sites with these IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
pageToken string Value of the nextPageToken from the previous result page.
searchString string Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
sortField string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)
subaccountId long Select only sites with this subaccount ID.
unmappedSite boolean Select only sites that have not been mapped to a directory site.


This request requires authorization with the following scope (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "dfareporting#sitesListResponse",
  "nextPageToken": string,
  "sites": [
    sites Resource
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
sites[] list Site collection.
nextPageToken string Pagination token to be used for the next list operation.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Campaign Manager
Campaign Manager