App Metric

Get all app metrics

This endpoint retrieves all the app metrics.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/metrics

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Create a new app metric

This endpoint allows creating a new app metric.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/metrics

Path parameters

entityId*string

Query parameters

Header parameters

Body

metric*string

namestring

descriptionstring

typestring

thresholdTimenumber

platformstring

eventNamestring

Response

Successful response

Body

successboolean

dataDappMetric (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metrics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metric": "metric-1"
    }),
});
const data = await response.json();

Response

{
  "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"
  }
}

Get app metrics info of a user

This endpoint retrieves the app metrics info for a user.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics/{metric}

Path parameters

entityId*string

userId*string

metric*string

Header parameters

Response

Successful response

Body

successboolean

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics/{metric}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Increment app metrics for a user

This endpoint allows to increment app metrics of a user.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics/{metric}

Path parameters

entityId*string

userId*string

metric*string

Query parameters

Header parameters

Body

countnumber

Response

Successful response

Body

successboolean

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics/{metric}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Get all app metrics of a user

This endpoint retrieves all the app metrics for a user.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics

Path parameters

entityId*string

userId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Increment multiple app metrics for a user

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics

Path parameters

entityId*string

userId*string

Query parameters

Header parameters

Body

metricsarray of object

Response

Successful response

Body

successboolean

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/metrics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Delete an app metric

This endpoint allows deleting an app metric.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/metrics/{metric}/delete

Path parameters

entityId*string

metric*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metrics/{metric}/delete', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true
}

Update an app metric

This endpoint allows updating an app metric.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/metrics/{metric}/update

Path parameters

entityId*string

metric*string

Query parameters

Header parameters

Body

namestring

descriptionstring

typestring

thresholdTimenumber

platformstring

eventNamestring

Response

Successful response

Body

successboolean

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metrics/{metric}/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Updated Metric Name",
      "description": "<p>Updated metric description.</p>",
      "type": "counter",
      "thresholdTime": 3600,
      "platform": "segment",
      "eventName": "updated_event",
      "__$markdownParsed": true
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Get metric claim summary

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

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/metrics/claims

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

dataarray of object

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metrics/claims', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get Dapp metric value for entity

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

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/getmetrics/{metric}

Path parameters

entityId*string

userId*string

metric*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

datanumber

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/getmetrics/{metric}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get metric summary for a quest

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

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/metric-summary

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

dataarray of object

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/metric-summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
      }
    }
  ]
}

PreviousCampaign NextMembership Card

Last updated 3 months ago