Event Metric Mapping

Get All Event Metric Mappings

Get all event metric mappings for a specific entity.

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

Path parameters

entityId*string

The ID of the entity.

Header parameters

Response

200500

Successful operation

Body

application/json

successboolean

dataarray of EventMetricMapping (object)

Request

JavaScriptCurl

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

Response

{
  "success": true,
  "data": [
    {
      "entityId": "exampleEntityId",
      "eventName": "exampleEventName",
      "properties": [
        {
          "value": "exampleValue"
        }
      ],
      "metrics": [
        "exampleMetric"
      ],
      "platform": "examplePlatform",
      "isDeleted": false
    }
  ]
}

Create Event Metric Mapping

Create a new event metric mapping for an entity.

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

Path parameters

entityId*string

The ID of the entity.

Header parameters

Body

application/json

eventName*string

properties*array of object

platform*string

Response

201500

Successful operation

Body

application/json

successboolean

messagestring

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventName": "text",
      "properties": [
        {}
      ],
      "platform": "text"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "message": "text"
}

Get Event Metric Mapping by Event Name

Retrieve event metric mapping details based on entity ID and event name.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}

Path parameters

entityId*string

The ID of the entity.

eventName*string

The name of the event.

Response

200400500

Successful operation

Body

application/json

entityIdstring

eventNamestring

propertiesarray of object

metricsarray of string

platformstring

isDeletedboolean

Request

JavaScriptCurl

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

Response

{
  "entityId": "exampleEntityId",
  "eventName": "exampleEventName",
  "properties": [
    {
      "value": "exampleValue"
    }
  ],
  "metrics": [
    "exampleMetric"
  ],
  "platform": "examplePlatform",
  "isDeleted": false
}

Update Event Metric Mapping by Event Name

Update event metric mapping details based on entity ID and event name.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/update

Path parameters

entityId*string

The ID of the entity.

eventName*string

The name of the event.

Header parameters

Body

application/json

Updated properties for the event metric mapping.

properties*array of object

platform*string

Response

200400500

Successful operation

Body

application/json

entityIdstring

eventNamestring

propertiesarray of object

metricsarray of string

platformstring

isDeletedboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "properties": [
        {
          "value": "exampleValue"
        }
      ],
      "platform": "examplePlatform"
    }),
});
const data = await response.json();

Response

{
  "entityId": "exampleEntityId",
  "eventName": "exampleEventName",
  "properties": [
    {
      "value": "exampleValue"
    }
  ],
  "metrics": [
    "exampleMetric"
  ],
  "platform": "examplePlatform",
  "isDeleted": false
}

Delete Event Metric Mapping by Event Name

Delete event metric mapping based on entity ID and event name.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/delete

Path parameters

entityId*string

The ID of the entity.

eventName*string

The name of the event.

Header parameters

Response

200400500

Successful operation

Body

application/json

any

Request

JavaScriptCurl

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

Remove Metrics from Event Metric Mapping

Remove specified metrics from an event metric mapping based on entity ID and event name.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/remove-metrics

Path parameters

entityId*string

The ID of the entity.

eventName*string

The name of the event.

Header parameters

Body

application/json

metric*string

Response

200400500

Successful operation

Body

application/json

any

Request

JavaScriptCurl

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

Create Many Event Metric Mappings

Create multiple event metric mappings.

POSThttps://api.questprotocol.xyz/api/create-many/eventMetricMapping

Header parameters

Body

application/json

data*array of EventMetricMapping (object)

Response

201500

Successful operation

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/create-many/eventMetricMapping', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": [
        {
          "entityId": "exampleEntityId1",
          "eventName": "exampleEventName1",
          "properties": [
            {
              "value": "exampleValue1"
            }
          ],
          "metrics": [
            "exampleMetric1"
          ],
          "platform": "examplePlatform1"
        },
        {
          "entityId": "exampleEntityId2",
          "eventName": "exampleEventName2",
          "properties": [
            {
              "value": "exampleValue2"
            }
          ],
          "metrics": [
            "exampleMetric2"
          ],
          "platform": "examplePlatform2"
        }
      ]
    }),
});
const data = await response.json();