Docker

DVP Data API

The Docker DVP Data API allows [Docker Verified Publishers](https://docs.docker.com/docker-hub/publish/) to view image pull analytics data for their…

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Docker DVP Data API allows Docker Verified Publishers 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

Endpoints 8

authentication

  • POSTSecond factor authentication.https://hub.docker.com/v2/users/2fa-loginWhen a user has 2FA enabled, this is the second call to perform after /v2/users/login call. Creates and returns a bearer token in JWT format that you can use…
  • POSTCreate an authentication tokenhttps://hub.docker.com/v2/users/loginCreates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs. The returned token is used in the HTTP Authorization…

namespaces

  • GETGet years with data/namespaces/:namespace/pulls/exports/yearsGets a list of years that have data for the given namespace
  • GETGet timespans with data/namespaces/:namespace/pulls/exports/years/:year/:timespantypeGets a list of timespans of the given type that have data for the given namespace and year
  • GETGet namespace metadata for timespan/namespaces/:namespace/pulls/exports/years/:year/:timespantype/:timespanGets info about data for the given namespace and timespan
  • GETGet namespace data for timespan/namespaces/:namespace/pulls/exports/years/:year/:timespantype/:timespan/:dataviewGets a list of URLs that can be used to download the pull data for the given namespace and timespan

discovery

  • GETGet namespaces and repos/Gets a list of your namespaces and repos which have data available
  • GETGet namespace/namespaces/:namespaceGets metadata associated with specified namespace, including extra repos associated with the namespace

API details

Base URL
https://hub.docker.com/api/publisher/analytics/v1
https://docker.com/{version}
Authentication
A bearer token in the Authorization header
Operations
8 operations on 8 pathsGET 6POST 2
Main resources
namespaces 4authentication 2discovery 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the DVP Data API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DVP Data API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Second factor authentication.” (POST https://hub.docker.com/v2/users/2fa-login), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DVP Data API?

The Docker DVP Data API allows [Docker Verified Publishers](https://docs.docker.com/docker-hub/publish/) to view image pull analytics data for their… It is listed under Developer tools and has 8 endpoints.

Who publishes the DVP Data API?

It is listed from Docker's public API description (an OpenAPI document), not published by Docker on Swastik Codes. Anyone who controls docker.com can claim the profile by adding a DNS TXT record.

What is the base URL of the DVP Data API?

Its description lists 2 base URLs: https://hub.docker.com/api/publisher/analytics/v1, https://docker.com/{version}. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the DVP Data API?

With A bearer token in the Authorization header.

How many endpoints does the DVP Data API have?

8 operations on 8 paths (6 GET, 2 POST). The largest groups are namespaces, authentication, discovery.

Is forking the DVP Data API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.