Share feedback
Answers are generated based on the documentation.
Product manualDownload OpenAPI specificationMarkdown

Hosted API

Publisher analytics API

API 1.0.0 · 12 operations · 26 named schemas

Overview

The Docker DVP Data API allows Docker Verified Publishers to view image pull analytics data for their namespaces. Analytics data can be retrieved in a CSV 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

Connecting to the Publisher analytics API

Docker Hub Authentication

JWT Bearer Authentication is required to access the Docker DVP Data API.

This authentication documentation is duplicated from the Hub API Authentication docs

https://hub.docker.com/api/publisher/analytics/v1

Operations

GET/Get namespaces and repos GET/namespacesGet user's namespaces GET/namespaces/{namespace}Get namespace GET/namespaces/{namespace}/pullsGet pull data 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 GET/namespaces/{namespace}/repos/{repo}/pullsGet pull data GET/repos/pullsGet pull data for multiple repos POST/v2/users/2fa-loginSecond factor authentication POST/v2/users/loginCreate an authentication token

Schemas