App Metric | Quest Protocol

Quest Protocol

Get app metrics info of a user

get

This endpoint retrieves the app metrics info for a user.

Path parameters

entityIdstringrequired

userIdstringrequired

metricstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics/{metric}' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "metric": "metric-1",
    "counter": 10
  }
}

Successful response

Get all app metrics of a user

get

This endpoint retrieves all the app metrics for a user.

Path parameters

entityIdstringrequired

userIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "id": "id-1",
    "name": "app-metric-name"
  }
}

Successful response

Delete an app metric

post

This endpoint allows deleting an app metric.

Path parameters

entityIdstringrequired

metricstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metrics/{metric}/delete?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

500

{
  "success": true
}

Successful response

Get metric claim summary

get

This endpoint retrieves a summary of metric claims for an entity.

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metrics/claims?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

500

{
  "success": true,
  "data": [
    {
      "metric": "metric-1",
      "count": 10
    }
  ]
}

Successful response

Get Dapp metric value for entity

get

This endpoint retrieves the value of a Dapp metric for an entity.

Path parameters

entityIdstringrequired

userIdstringrequired

metricstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/getmetrics/{metric}?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

500

{
  "success": true,
  "data": 10
}

Successful response

Get metric summary for a quest

get

This endpoint retrieves the metric summary for a quest in a specified entity.

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/metric-summary?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

401

500

{
  "success": true,
  "data": [
    {
      "metric": "quest-metric-1",
      "date": "2023-12-31",
      "count": 10,
      "metricDetails": {
        "metric": "quest-metric-1",
        "entityId": "entity-id-1",
        "type": "metric-type",
        "name": "metric-name",
        "description": "metric-description",
        "thresholdTime": 60000,
        "isEnabled": true,
        "createdAt": "2023-01-01T00:00:00Z",
        "platform": "segment",
        "eventName": "metric-event"
      }
    }
  ]
}

Successful response

Get all app metrics

get

This endpoint retrieves all the app metrics.

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metrics?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

500

{
  "success": true,
  "data": {
    "id": "id-1",
    "name": "app-metric-name"
  }
}

Successful response

Create a new app metric

post

This endpoint allows creating a new app metric.

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

metricstringrequired

Example: metric-1

namestringoptional

Example: Metric Name

descriptionstringoptional

Example: Metric description

typestringoptional

Example: metric_type

thresholdTimenumberoptional

Example: 10

platformstringoptional

Example: segment

eventNamestringoptional

Example: metric_event

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metrics?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "metric": "metric-1",
    "name": "Metric Name",
    "description": "Metric description",
    "type": "metric_type",
    "thresholdTime": 10,
    "platform": "segment",
    "eventName": "metric_event"
  }'

200

400

500

{
  "success": true,
  "data": {
    "metric": "metric-1",
    "entityId": "entityId-1",
    "type": "metric_type",
    "name": "Metric Name",
    "description": "Metric description",
    "thresholdTime": 10,
    "isEnabled": true,
    "createdAt": "2023-01-01T00:00:00Z",
    "platform": "segment",
    "eventName": "metric_event"
  }
}

Successful response

Increment app metrics for a user

post

This endpoint allows to increment app metrics of a user.

Path parameters

entityIdstringrequired

userIdstringrequired

metricstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

countnumberoptional

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics/{metric}?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "count": 10
  }'

200

400

401

500

{
  "success": true
}

Successful response

Increment multiple app metrics for a user

post

This endpoint allows to increment multiple app metrics of a user.

Path parameters

entityIdstringrequired

userIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

metricsobject[]optional

Example: [{"metricId":"dummy-id","count":10}]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "metrics": [
      {
        "metricId": "dummy-id",
        "count": 10
      }
    ]
  }'

200

400

401

500

{
  "success": true
}

Successful response

Update an app metric

post

This endpoint allows updating an app metric.

Path parameters

entityIdstringrequired

metricstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

namestringoptional

descriptionstringoptional

typestringoptional

thresholdTimenumberoptional

platformstringoptional

eventNamestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metrics/{metric}/update?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Updated Metric Name",
    "description": "Updated metric description.",
    "type": "counter",
    "thresholdTime": 3600,
    "platform": "segment",
    "eventName": "updated_event"
  }'

200

500

{
  "success": true
}

Successful response

Get app metrics info of a user

Get all app metrics of a user

Delete an app metric

Get metric claim summary

Get Dapp metric value for entity

Get metric summary for a quest

Get all app metrics

Create a new app metric

Increment app metrics for a user

Increment multiple app metrics for a user

Show child attributes

Update an app metric