Get privacy-safe account analytics.

GET

/v1/analytics

const url = 'https://api.share2.us/v1/analytics';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.share2.us/v1/analytics \
  --header 'Authorization: Bearer <token>'

Authorizations

Responses

200

Account analytics.

application/json

object

total_views

required

integer format: int64

total_downloads

required

integer format: int64

active_shares

required

integer format: int64

unique_visitors

required

integer format: int64

top_shares

required

Array<object>

object

public_id

required

string

file_name

required

string

views

required

integer format: int64

downloads

required

integer format: int64

timeline

required

Array<object>

object

date

required

string

views

required

integer format: int64

downloads

required

integer format: int64

recent

required

Array

object

occurred_at

required

string format: date-time

country

required

string

event_type

required

string

Allowed values: share.viewed share.downloaded

accessed_by

required

string

accessor_kind

required

string

Allowed values: teammate recipient registered anonymous

public_id

required

string

file_name

required

string

by_country

required

Array<object>

object

country

required

string

downloads

required

integer format: int64

views

required

integer format: int64

notif_unread

In-app unread notification count, folded into the nav poll (ADR-018).

integer format: int64

Example

{
  "recent": [
    {
      "event_type": "share.viewed",
      "accessor_kind": "teammate"
    }
  ]
}

default

Standard error envelope.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}