Yandex Metrica

Availability:

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level:

community

Connector Version:

1.0.5

This page contains the setup guide and reference information for the Yandex Metrica source connector.

Prerequisites

• Counter ID
• OAuth2 Token

Setup guide

Step 1: Set up Yandex Metrica

1. Create Yandex Metrica account if you don't already have one.
2. Head to Management page and add new tag or choose an existing one.
3. At the top of the dashboard you will see 8 digit number to the right of your website name. This is your Counter ID.
4. Create a new app or choose an existing one from My apps page.
   • Which platform is the app required for?: Web services
   • Callback URL: https://oauth.yandex.com/verification_code
   • What data do you need?: Yandex.Metrica. Read permission will suffice.
5. Choose your app from the list.
   • To create your API key you will need to grab your ClientID,
   • Now to get the API key craft a GET request to an endpoint https://oauth.yandex.com/authorizE?response_type=token&client_id=YOUR_CLIENT_ID
   • You will receive a response with your API key. Save it.

Step 2: Set up the Yandex Metrica connector in Airbyte

1. Log into your Airbyte Cloud account.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Yandex Metrica from the Source type dropdown.
4. Enter a name for the Yandex Metrica connector.
5. Enter Authentication Token from step 1.
6. Enter Counter ID.
7. Enter the Start Date in format YYYY-MM-DD.
8. Enter the End Date in format YYYY-MM-DD (Optional).

For Airbyte Open Source:

1. Navigate to the Airbyte Open Source dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Yandex Metrica from the Source type dropdown.
4. Enter the name for the Yandex Metrica connector.
5. Enter Authentication Token from step 1.
6. Enter Counter ID.
7. Enter the Start Date in format YYYY-MM-DD.
8. Enter the End Date in format YYYY-MM-DD (Optional).

Supported sync modes

The Yandex Metrica source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

• Views (Incremental).
• Sessions (Incremental).

Performance considerations

Yandex Metrica has some rate limits

tip

It is recommended to sync data once a day.

note

Because of the way API works some syncs may take a long time to finish. Timeout period is 2 hours.

Data type mapping

Integration Type	Airbyte Type	Notes
string	string
integer	integer
number	number
array	array
object	object

Reference

Config fields reference

Field

Type

Property name

string

auth_token

string

counter_id

string

start_date

string

end_date

Changelog

Expand to review

Version	Date	Pull Request	Subject
1.0.5	2024-06-04	38999	[autopull] Upgrade base image to v1.2.1
1.0.4	2024-04-19	37296	Updating to 0.80.0 CDK
1.0.3	2024-04-18	37296	Manage dependencies with Poetry.
1.0.2	2024-04-15	37296	Base image migration: remove Dockerfile and use the python-connector-base image
1.0.1	2024-04-12	37296	schema descriptions
1.0.0	2023-03-20	24188	Migrate to Beta; Change state structure
0.1.0	2022-09-09	15061	🎉 New Source: Yandex metrica