Skip to main content

Gapy is a thin service account client for Google Analytics.

Get set up

First you need to create either a service account or client ID in your Google API Console. If you’re authenticating as a service account you’ll need to download your private key.

If you’re authenticating as a web or installed application you’ll need to download your client secrets file. Use the Google Developers Console to do this:

  • Create a Project for thte application, and add the Analytics API to the Enabled APIs list.

  • In “Credentials”, click “Create new Client ID”.

  • Choose “Installed Application” and type should be “Other”.

  • Once it’s generated your ID, click the new “Download JSON” button and save this file as client_secrets.json.

Then just create a gapy client and start querying.

  • storage_path is the location where you want gapy to keep the storage.db file that it will generate the first time it runs.

  • Ids, metrics and dimensions can be provided as lists or single values.

import gapy.client

# For a service account
client = gapy.client.from_private_key(
    "your account name",
    private_key="your private key",
    storage_path="path/to/storage.db")

# For a web or installed application
client = gapy.client.from_secrets_file(
    "/path/to/client_secrets.json",
    storage_path="/path/to/storage.db")
)


reach_data = client.query.get("12345",
            datetime(2012, 1, 1),
            datetime(2012, 2, 2),
            ['ga:visits', 'ga:visitors'],
            'ga:date')

Google API documentation

This library is a layer over the Google Python API. If you wish to work on it, it may be necessary to consult the Google Analytics API documentation.

Metadata

Release files for gapy 1.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gapy 1.3.4
File Size Uploaded
gapy-1.3.4.tar.gz 5.1 kB Details

Release files / gapy-1.3.4.tar.gz

Download URL gapy-1.3.4.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
dcc1f9212d1a258134f7b76d94b713ff153860ae60f46f2d2f20e97af0a78a70
BLAKE2b-256 checksum
How to use checksums
a516a1aba854976cd24f23e2ab4a7c5d373aad2d41305194bff841f31165def9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.3.6

1 release file

1.3.5

1 release file

This release

1.3.4 This release

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.0

1 release file

1.1.0

1 release file

1.0.0

1 release file

0.0.9

1 release file

0.0.8

1 release file

0.0.7

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page