Data Octopus
Contents
Introduction

Access setup guide

Access needed to set up Data Octopus: how to connect your shop engine, Google Analytics 4, Google Ads and Meta Ads. All permissions are read-only.

IdoSell API

Open the access panel: yourdomain.com/panel/users-api.php (use your own domain) and click "+ Add new key".

The "Add new key" button in the IdoSell API panel
The "Add new key" button in the IdoSell API panel

A window for configuring the new API access key opens. In it:

  1. 1Choose API key.
  2. 2Enter the name Data Octopus.
  3. 3Enter the e-mail address given in the form.
  4. 4Set Active to Yes.
  5. 5Set PIM to Read only.
  6. 6Set OMS to Read only.
  7. 7Click Add.
New IdoSell API key form with read-only permissions
New IdoSell API key form with read-only permissions

After creating the key, go back to users-api.php and click Edit.

The Edit button next to the IdoSell API key
The Edit button next to the IdoSell API key

Click Show key, copy it and paste it into the form.

The Show key button in IdoSell
The Show key button in IdoSell

Shopify API

Connecting Data Octopus to a Shopify store requires creating a dedicated app in the admin panel. It gives secure, read-only data access via an API key.

Step 1: Go to app settings

Click Settings in the bottom-left corner.

The Settings button in the Shopify admin
The Settings button in the Shopify admin

In the settings menu, choose Apps and sales channels.

Apps and sales channels in Shopify settings
Apps and sales channels in Shopify settings

Step 2: Open the developer dashboard

Click Develop apps in the top-right corner.

The Develop apps button in Shopify
The Develop apps button in Shopify

Then click Build apps in Dev Dashboard.

The Build apps in Dev Dashboard button
The Build apps in Dev Dashboard button

Step 3: Create and name a new app

Click Create app in the top-right corner.

The Create app button in the Shopify developer dashboard
The Create app button in the Shopify developer dashboard

Enter DataOctopus as the App name so it's clear who was given access, then click Create.

App name field set to DataOctopus
App name field set to DataOctopus

Step 4: Configure permissions (API scopes)

This is the key step. In the app configuration panel, scroll to the Access section.

The Access section in the Shopify app configuration
The Access section in the Shopify app configuration

Paste the following permissions into the Scopes field – they give read-only access to the required data:

Scopes
read_analytics, read_gift_cards, read_customers, read_orders, read_products

Step 5: Save and install the app

After pasting the scopes, click Release in the bottom-right corner.

The Release button in the Shopify app configuration
The Release button in the Shopify app configuration

In the new window, click Release again without filling in any extra fields.

Release confirmation window
Release confirmation window

On the app's main page, click Install app in the top-right corner.

The Install app button in Shopify
The Install app button in Shopify

Confirm the installation by clicking Install.

Confirming the DataOctopus app installation
Confirming the DataOctopus app installation
The installed DataOctopus app in Shopify
The installed DataOctopus app in Shopify

Step 6: Copy the API key and store address

After installation Shopify shows the API key. If you closed that window, go back to Settings > Apps and sales channels > Develop apps and select the DataOctopus app.

The DataOctopus app in the Shopify app list
The DataOctopus app in the Shopify app list

In the Credentials section, copy the Admin API access token and paste it into the Data Octopus registration form.

The Admin API access token is unique and required to complete the integration.

The Credentials section with the Admin API access token
The Credentials section with the Admin API access token

Finally, in Settings > Store details you'll find the store address in the format store-name.myshopify.com. Copy it and paste it into the form too.

The myshopify.com store address in Store details
The myshopify.com store address in Store details

Shoper API

Connecting Data Octopus to Shoper requires creating an External Integration in the admin panel, which provides data access via an API token.

Step 1: Start adding a new integration

  1. 1In the side panel, choose Add-ons and integrations (1).
  2. 2Click External integrations (2).
  3. 3Click Add integration in the top-right corner (3).
External integrations and the Add integration button in Shoper
External integrations and the Add integration button in Shoper

Step 2: Fill in the basic settings

  1. 1Tool: choose Other (1).
  2. 2Integration name: enter DataOctopus Integration (2) so it's clear who was given access.
  3. 3Description: optional (recommended), e.g. "DataOctopus <> Shoper data integration" (3).
Basic integration settings in Shoper
Basic integration settings in Shoper

Step 3: Grant integration permissions (read)

In the Integration permissions section, add a read permission for each of these data categories:

  • Orders
  • Products
  • Producers
  • Currencies
  • Deliveries
  • Categories
  • Availability states
  • Order statuses
  1. 1In Shop area (1), choose one item, e.g. orders.
  2. 2In Access scope (2), always choose read.
  3. 3Click Add permission (3).
  4. 4Repeat until the list contains all 8 items with read scope.
List of read permissions for the integration in Shoper
List of read permissions for the integration in Shoper

Step 4: Save and create the token

Once all permissions are added, scroll down and click Save and create token.

Step 5: Copy and send the API token

Copy the API token immediately – it can't be viewed again once the page is closed. If you close it without copying, you'll need to create a new token.

  1. 1Copy the Client ID and the API token.
  2. 2Paste both into the Data Octopus onboarding form.
  3. 3Click I understand (1).
Summary with the Client ID and API token in Shoper
Summary with the Client ID and API token in Shoper

PrestaShop API

Step 1: Go to settings and enable Webservice

Enabling Webservice in PrestaShop
Enabling Webservice in PrestaShop

Step 2: Create an API access key

Open the Webservice page under Advanced Parameters and click Add new webservice key. In the window:

  1. 1Click Generate to create a new key – send it in the registration form you received from Data Octopus.
  2. 2In the description, note who uses the key, e.g. "DataOctopus app".
  3. 3Set the status to YES – this enables the key.
  4. 4In permissions, tick every method in the GET column.

The Data Octopus app never changes your data – it only reads it for analysis.

PrestaShop Webservice key with GET permissions
PrestaShop Webservice key with GET permissions

Google Analytics 4

To add Google Analytics 4 data to the Data Octopus app, after signing in to the panel:

  1. 1Click the shop you want to add data to.
  2. 2Go to the Sources section.
  3. 3Choose Google Analytics 4.
The Sources section in the Data Octopus app with the Google Analytics 4 tile
The Sources section in the Data Octopus app with the Google Analytics 4 tile

After clicking Google Analytics 4, a panel opens on the right where you enter the Google Analytics property identifier – Property Id.

The Property Id field in the Google Analytics 4 panel
The Property Id field in the Google Analytics 4 panel

To find the property number in Google Analytics 4, open Admin in the bottom-left corner.

The Admin button in the bottom-left corner of Google Analytics 4
The Admin button in the bottom-left corner of Google Analytics 4

Then open settings (1) and, under property settings, click property details (2). The number is in the top-right corner (3). Paste the copied property ID into the form.

Property details in Google Analytics 4 showing the property ID
Property details in Google Analytics 4 showing the property ID

After entering the ID, click Add and confirm access with a Google account that has at least Viewer access to the property.

Google sign-in window when confirming Google Analytics 4 access
Google sign-in window when confirming Google Analytics 4 access

When approving access, tick the checkbox "See and download your Google Analytics data".

The "See and download your Google Analytics data" consent
The "See and download your Google Analytics data" consent

To add Google Ads data to the Data Octopus app, after signing in to the panel:

  1. 1Click the shop you want to add data to.
  2. 2Go to the Sources section.
  3. 3Choose Google Ads.
The Sources section in the Data Octopus app with the Google Ads tile
The Sources section in the Data Octopus app with the Google Ads tile

After clicking Google Ads, a panel opens on the right where you enter:

  • The Google Ads account ID.
  • The Manager Account ID – only if the account is managed through a Manager Account. If the person authorising has direct access to the Google Ads account, leave this field empty.
Account ID and Manager Account ID fields in the Google Ads panel
Account ID and Manager Account ID fields in the Google Ads panel

After entering the ID, click Add and confirm access with a Google account that has at least Viewer access to the account.

Confirming Google Ads access with a Google account
Confirming Google Ads access with a Google account

You'll find the ad account number in the top-right corner of the Google Ads main panel.

Meta Ads

In the Business Manager main panel, choose Accounts in the left column, then the Ad Accounts tab. The Name column shows the ad account name with its number (ID) underneath.

Ad accounts view in Business Manager
Ad account list in Business Manager with the account ID
Ad account list in Business Manager with the account ID

Alternatively, use Ads Manager: click the drop-down in the top-left corner and copy the number shown under the account name.

Meta Ads Manager
Ad account number in the Meta Ads Manager drop-down
Ad account number in the Meta Ads Manager drop-down

In the form, enter the account number together with the code of the country the account targets.