Skip to content

DVP Data API API

by docker.com

Bearer tokenHTTPSDevelopment
Open documentation ↗

Overview

The Docker DVP Data API allows [Docker Verified Publishers](https://docs.docker.com/docker-hub/publish/) to view image pull analytics data for their namespaces. Analytics data can be retrieved as raw data, or in a summary format. #### Summary data In your summary data CSV, you will have access to the data points listed below. You can request summary data for a complete week (Monday through Sunday) or for a complete month (available on the first day of the following month). There are two levels of summary data: - Repository-level, a summary of every namespace and repository - Tag- or digest-level, a summary of every namespace, repository, and reference (tag or digest) The summary data formats contain the following data points: - Unique IP address count - Pulls by tag count - Pulls by digest count - Version check count #### Raw data In your raw data CSV you will have access to the data points listed below. You can request raw data for a complete week (Monday through Sunday) or for a complete month (available on the first day of the following month). **Note:** each action is represented as a single row. - Type (industry) - Host (cloud provider) - Country (geolocation) - Timestamp - Namespace - Repository - Reference (digest is always included, tag is provided when available) - HTTP request method - Action, one of the following: - Pull by tag - Pull by digest - Version check - User-Agent

DVP Data API is a development API from docker.com. Requests are authenticated with a bearer token. It is served over HTTPS. Its OpenAPI description documents 8 endpoints.

At a glance

Authentication
Bearer token
HTTPS
Yes
CORS
Unknown
Category
Development
Base URL
https://hub.docker.com/api/publisher/analytics/v1
Version
1.0.0
Endpoints
8
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://hub.docker.com/api/publisher/analytics/v1/" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://hub.docker.com/api/publisher/analytics/v1/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://hub.docker.com/api/publisher/analytics/v1/",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/Get namespaces and repos
GET/namespaces/{namespace}Get namespace
GET/namespaces/{namespace}/pulls/exports/yearsGet years with data
GET/namespaces/{namespace}/pulls/exports/years/{year}/{timespantype}Get timespans with data
GET/namespaces/{namespace}/pulls/exports/years/{year}/{timespantype}/{timespan}Get namespace metadata for timespan
GET/namespaces/{namespace}/pulls/exports/years/{year}/{timespantype}/{timespan}/{dataview}Get namespace data for timespan
POST/v2/users/2fa-loginSecond factor authentication.
POST/v2/users/loginCreate an authentication token

Questions

Does the DVP Data API API need an API key?

Yes. The DVP Data API API uses Bearer token authentication; the documentation explains how to get credentials.

Does the DVP Data API API support HTTPS?

Yes, the DVP Data API API is served over HTTPS.

How many endpoints does the DVP Data API API have?

Its OpenAPI description lists 8 endpoints in version 1.0.0. All of them are shown on this page.

What are alternatives to the DVP Data API API?

Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.

Compare alternatives →

Listed from APIs.guru (CC0).