Overview

The analytics data recorded provide a window into how people are interacting with the government online. The data come from a unified Google Analytics account for U.S. federal government agencies known as the Digital Analytics Program (DAP). This program helps government agencies understand how people find, access, and use government services online. The program does not track individuals and anonymizes the IP addresses of visitors.

A subset of the DAP analytics data reports are available via the DAP API. These reports may be limited to a specific domain or agency to support a wide range of user needs. Report data are limited to sites which have a minimum of 50 visits in the report period. Data may be subject to sampling and should not be relied upon for 100% accuracy. This data should be used to examine high-level trends and provide general insights into user demographics and behavior.

The URL for the API is https://api.gsa.gov/analytics/dap, and it exposes 3 routes to query DAP analytics data:

• /v<version number>/reports/<report name>/data
• /v<version number>/agencies/<agency name>/reports/<report name>/data
• /v<version number>/domain/<domain>/reports/<report name>/data

Quick Links:

• Getting started
• Authentication
• Endpoints
• Migrating from API V1 to API V2
• Contact us

Back to top

Getting started

To begin using this API, you will need to register for an API Key. See the Authentication section for details.

Common use cases

Below are a few examples of API calls and their use cases. For the example calls below we’ll use the curl library and a placeholder API key 1234.

Find data for a date range

To limit a call to a certain time frame, use the before and after query params

# Get 7 days of site data
curl --header "x-api-key: 1234" https://api.gsa.gov/analytics/dap/v2/reports/site/data?after=2024-06-01&before=2024-06-07

Find data for a particular domain name

To limit results to a certain domain, use the /domain/my.domain.com path

# Get top 10 downloads for ssa.gov
curl --header "x-api-key: 1234" https://api.gsa.gov/analytics/dap/v2/domain/www.ssa.gov/reports/download/data?limit=10

Find data for a particular agency

To limit results to a certain agency, use the /agencies/some-agency path

# Get traffic source data for the Department of State
curl --header "x-api-key: 1234" https://api.gsa.gov/analytics/dap/v2/agencies/state/reports/traffic-source/data

Authentication

You can sign up for an API key below. After registration, you will need to provide this API key in the x-api-key HTTP header with every API request.

Back to top

Endpoints

There are 3 supported endpoints in the API. All endpoints are read-only, and accessed with HTTP GET requests. All endpoints are preceded by an API version

Endpoint quick links:

• API versions
• /reports
• /agencies
• /domain
• Query params
• Response structure
• HTTP response codes
• OpenAPI specification file

API versions

DAP API V1 returns data from Google Analytics V3, also known as Universal Analytics (UA). DAP API V1 data includes data recorded in UA by DAP from January 1st 2018 to Google’s retirement date for UA (June 24 2024).

Google has retired UA and new data may only be recorded in their new version, Google Analytics V4 (GA4).

DAP API V2 returns data recorded in GA4 by DAP beginning on DAP’s launch date for GA4 recording code, August 1st 2023 to the present.

The GA4 data returned has some slightly different fields which are described in Migrating from API V1 to API V2.

Valid API versions are 1.1 and 2. API version should be included in the path for all endpoints like the following examples

# API V1
https://api.gsa.gov/analytics/dap/v1.1/reports/site/data

# API V2
https://api.gsa.gov/analytics/dap/v2/reports/site/data

/reports

This route returns data at a government wide scope. Report metrics will be totals combining metrics for participating hostnames in all DAP agencies. See available reports for a list of all supported report names. The report_agency field in the response data will be empty string or undefined in these reports because they apply to all DAP agencies.

Path structure

Replace <report name> with the API name of the desired report.

/reports/<report name>/data

Example

# Get 30 days of government wide user language demographics data
curl --header "x-api-key: 1234" https://api.gsa.gov/analytics/dap/v2/reports/language/data?after=2024-06-01&before=2024-06-30

/agencies

This route returns data at an agency scope. Report metrics will be totals combining participating hostnames belonging to the requested agency. See available agencies for a list of agencies which participate in the DAP program and their API agency name. See available reports for a list of all supported report names.

Path structure

Replace <agency name> with the API name of the agency. Replace <report name> with the API name of the desired report.

/agencies/<agency name>/reports/<report name>/data

Example

# Get 30 days of user operating system demographics data for the Department of
# Defense
curl --header "x-api-key: 1234" https://api.gsa.gov/analytics/dap/v2/agencies/defense/reports/os/data?after=2024-06-01&before=2024-06-30

/domain

This route returns data at a domain scope. Report metrics will be totals for the requested domain. The domain route supports only the site, domain, download, and second-level-domain report names.

Path structure

Replace <domain> with the desired domain for the report. Replace <report name> with the API name of the desired report.

/domain/<domain>/reports/<report name>/data

Example

# Get 30 days of visit data for www.ssa.gov
curl --header "x-api-key: 1234" https://api.gsa.gov/analytics/dap/v2/domain/www.ssa.gov/reports/site/data?after=2024-06-01&before=2024-06-30

Query params

The following query params are supported by all endpoints:

• limit: Limit the number of data points that are rendered. The default is 1000 and the max is 10,000
• page: Pages through the results. If the limit is set to 1000, using page=2 will render the 1001st through 2000th data point. Defaults to page 1.
• after: Limit the results to data with dates on or after the date specified. Expects YYYY-MM-DD date format.
• before: Limit the results to data with dates on or before the date specified. Expects YYYY-MM-DD date format. Defaults to the current date.

Response structure

All endpoints follow the same response structure. The response represents the rows in the data array in the JSON reports that can be downloaded from analytics.usa.gov, or the rows in the CSV files that can be downloaded. They are returned as an array of JSON objects.

Here is an example of one such object:

{
  "id": 60716,
  "report_name": "today",
  "report_agency": "justice",
  "date": "2017-04-07T14:00:00.000Z",
  "visits": "4240",
  "created_at": "2017-04-07T04:23:55.792Z",
  "updated_at": "2017-04-07T04:23:55.792Z"
}

Note that is has the following properties:

• id: The primary key of the data point entry in the DAP API database.
• report_name: The name of the data point’s report
• report_agency: The name of the data point’s agency. This will be empty or undefined when the data point is at the government wide scope
• date: The date/time corresponding to the data in the data point
• visits: The requested visit data for the data point. This is shown as an example of possible data fields that will be included as siblings to the required properties above. Properties such as visits, browser, screen size, and so on, can be included depending on the report. See analytics definitions for more details on dimensions and metrics.

HTTP response codes

The API will return one of the following responses:

OpenAPI specification file

You can view the full details of this API in the OpenAPI Specification file available here: Open API specification file for the Digital Analytics Program API

Back to top

Available reports

The following reports can be queried using the API:

Available agencies

The following agencies can be queried using the API:

Back to top

Migrating from API V1 to API V2

Background

As described in API versions, API V1 returns data from Google Analytics version 3, and DAP API V2 returns data from Google Analytics version 4.

The GA4 data returned has some slightly different fields which are described below.

Requests

The DAP API endpoints are the same between V1 and V2, the only difference for API requests is the API version string.

Responses

Response data is slightly different in DAP API V2. This change is due to the data provided by Google Analytics. Some data fields were retired in GA4, and some other useful data fields were added. The changes follow:

Deprecated fields from V1

• browser_version
• has_social_referral
• exits
• exit_page

New fields in V2

file_name

The page path of a downloaded file.

language_code

The ISO639 language setting of the user’s device. e.g. ‘en-us’

session_default_channel_group

An enum which describes the session. Possible values:

‘Direct’, ‘Organic Search’, ‘Paid Social’, ‘Organic Social’, ‘Email’, ‘Affiliates’, ‘Referral’, ‘Paid Search’, ‘Video’, and ‘Display’

Back to top

Contact us

To suggest a feature or ask for help, please file an issue in our project repository.

Back to top