Data Module

Consists of all APIs to measure dApp metrics

Get all app metrics for an entity

List all the metrics available for an entity

GET https://api.questprotocol.xyz/api/entities/{entityID}/metrics

Path Parameters

NameTypeDescription

entityID*

String

Query Parameters

NameTypeDescription

address*

String

signature*

String

```json
{
    "success": true,
    "data": [
        {
            "id": "testm1",
            "name": "testm1"
        },
        {
            "id": "testm2",
            "name": "testm2"
        },
        {
            "id": "testm3",
            "name": "testm3"
        }
    ]
}
```

Can only be performed by the admin/owner of the Entity.

Get all app metrics for a user in an entity

GET https://api.questprotocol.xyz/api/entities/{entityID}/users/{userAddress}/metrics

Path Parameters

NameTypeDescription

entityID*

String

userAddress*

String

Query Parameters

NameTypeDescription

address*

String

signature*

String

{
    "success": true,
    "data": [
        {
            "metric": "test",
            "counter": 4
        }
    ]
}

Can only be performed by the admin/owner of the Entity.

Increment a app metric for a user in entity

Increments a app metric for a user in entity, can only be done by Entity Admins/Owners.

POST https://api.questprotocol.xyz/api/entities/{entityID}/users/{userAddress}/metrics/{metric}

Path Parameters

NameTypeDescription

entityID*

String

userAddress*

String

metric*

String

Query Parameters

NameTypeDescription

address*

String

signature*

String

Request Body

NameTypeDescription

count*

String

{
    success: true
}

Can only be performed by the admin/owner of the Entity.

Increment multiple app metrics for a user in entity

Increment multiple app metrics for a user in entity, can only be done by Entity Admins/Owners.

POST https://api.questprotocol.xyz/api/entities/{entityID}/users/{userAddress}/metrics

Path Parameters

NameTypeDescription

entityID*

String

userAddress*

String

Query Parameters

NameTypeDescription

address*

String

signature*

String

Request Body

NameTypeDescription

metrics*

Array

counts*

Array

{
    success: true
}

Can be only performed by the admin of the Entity.

Updates App metric information for an Entity. Can be only performed by the admin of the Entity.

POST https://api.questprotocol.xyz/api/entities/{entityID}/metrics/{metricID}/update

Path Parameters

NameTypeDescription

entityID*

String

metricID*

String

Query Parameters

NameTypeDescription

signature*

String

address

String

Request Body

NameTypeDescription

name*

String

description*

String

type*

String

Can only be performed by the admin/owner of the Entity.

Last updated