@arcxmoney/analytics

ArcxAnalyticsSdk

ArcxAnalyticsSdk is a wrapper for Arcx Analytics Api, which is created for increasing usability and simplicity for our api.

const arcxAnalyticsSdk = await ArcxAnalyticsSdk.init(YOUR_API_KEY)
await arcxAnalyticsSdk.event('EXAMPLE_EVENT', {
  attribute: 'random',
  anotherAttribute: 'value',
})

Installation

npm install @arcx-attribuition-sdk
yarn add @arcx-analytics-sdk

Api

• init
• event
• page
• transaction
• connectWallet

init

This function is used to initializate the ArcxAnalyticsSdk instance. An api key is required to initializing the instance. In order to get your key please contact us to initiate the collaboration process.

init takes two arguments:

1. Generated by Arcx Team api key - required
2. Sdk configuration (detail info explainded below in the example) - optional

Example:

import { ArcxAnalyticsSdk } from 'arcx-analytics-sdk'

...
await arcxAnalyticsSdk = await ArcxAnalyticsSdk.init(
  YOUR_API_KEY,
  {
    trackPages: true, // default - automatically trigger PAGE event if url changed after click
    cacheIdentity: true, // default - cache identity of user in his browser's local storage
  }
)

event

Save a custom event in order to be analysed by Arcx Team.

Example:

import { ArcxAnalyticsSdk } from 'arcx-analytics-sdk'

...
await arcxAnalyticsSdk = await ArcxAnalyticsSdk.init(YOUR_API_KEY)
await arcxAnalyticsSdk.event(
  'EXAMPLE_EVENT',
  {
    attribute: 'random',
    anotherAttribute: 'value',
  },
)

page

Used to save a standardized event in order to standardize and simplify tracking page's changes.

Example:

import { ArcxAnalyticsSdk } from 'arcx-analytics-sdk'

...
await arcxAnalyticsSdk = await ArcxAnalyticsSdk.init(YOUR_API_KEY)
await arcxAnalyticsSdk.page(
  'EXAMPLE_EVENT',
  {
    url: 'https://target.url',
  },
)

transaction

Used to save a standardized event in order to standardize and simplify tracking executed transactions.

Example:

import { ArcxAnalyticsSdk } from 'arcx-analytics-sdk'

...
await arcxAnalyticsSdk = await ArcxAnalyticsSdk.init(YOUR_API_KEY)

await analyticsSdk.transaction(
  transactionType, // required(string) - type of trasaction e.g. 'SWAP', 'STAKE'...
  transactionHash, // optional(string) - hash of the transaction
  attributes, // optional(object) - additional information about transaction
)

connectWallet

Used to save a standardized event in order to standardize and simplify tracking connected wallets.

Example:

import { ArcxAnalyticsSdk } from 'arcx-analytics-sdk'

...
await arcxAnalyticsSdk = await ArcxAnalyticsSdk.init(YOUR_API_KEY)

await analyticsSdk.connectWallet({
  account: '0x1234',
  chain: '1',
})