Google

Data Portability API

The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application.…

Data & analytics#openapi

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 Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.

Endpoints 6

accessType

  • POSTGets the access type of the token./v1/accessType:checkGets the access type of the token.

archiveJobs

  • POSTCancels a Portability Archive job./v1/:name:cancelCancels a Portability Archive job.
  • GETRetrieves the state of an Archive job for the Portability API./v1/:nameRetrieves the state of an Archive job for the Portability API.
  • POSTRetries a failed Portability Archive job./v1/:name:retryRetries a failed Portability Archive job.

authorization

  • POSTRevokes OAuth tokens and resets exhausted scopes for a user/project pair/v1/authorization:resetRevokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This…

portabilityArchive

  • POSTInitiates a new Archive job for the Portability API./v1/portabilityArchive:initiateInitiates a new Archive job for the Portability API.

API details

Base URL
https://dataportability.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 73 scopes
An API key in the key query parameter
Operations
6 operations on 6 pathsPOST 5GET 1
Main resources
archiveJobs 3accessType 1authorization 1portabilityArchive 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Data Portability 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 Data Portability API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 73 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the access type of the token.” (POST /v1/accessType:check), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Data Portability API?

The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application.… It is listed under Data & analytics and has 6 endpoints.

Who publishes the Data Portability API?

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

What is the base URL of the Data Portability API?

Requests go to https://dataportability.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Data Portability API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 73 scopes; an API key in the key query parameter.

How many endpoints does the Data Portability API have?

6 operations on 6 paths (5 POST, 1 GET). The largest groups are archiveJobs, accessType, authorization, portabilityArchive.

Is forking the Data Portability 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.