Event Metric Mapping | Quest Protocol

Quest Protocol

Get All Event Metric Mappings

Get all event metric mappings for a specific entity.

get

/entities/{entityId}/eventMetricMapping

Path parameters

entityIdstringrequired

The ID of the entity.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

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}/eventMetricMapping' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

500

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

Successful operation

Create Event Metric Mapping

Create a new event metric mapping for an entity.

post

/entities/{entityId}/eventMetricMapping

Path parameters

entityIdstringrequired

The ID of the entity.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

eventNamestringrequired

platformstringrequired

propertiesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "eventName": "text",
    "platform": "text",
    "properties": [
      {
        "value": "text"
      }
    ]
  }'

201

500

{
  "success": true,
  "message": "New Event metric mapping created successfully."
}

Successful operation

Get Event Metric Mapping by Event Name

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

get

/entities/{entityId}/eventMetricMapping/eventName/{eventName}

Path parameters

entityIdstringrequired

The ID of the entity.

Example: exampleEntityId

eventNamestringrequired

The name of the event.

Example: exampleEventName

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}'

200

400

500

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

Successful operation

Update Event Metric Mapping by Event Name

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

post

/entities/{entityId}/eventMetricMapping/eventName/{eventName}/update

Path parameters

entityIdstringrequired

The ID of the entity.

Example: exampleEntityId

eventNamestringrequired

The name of the event.

Example: exampleEventName

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

platformstringrequired

propertiesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/update' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "platform": "examplePlatform",
    "properties": [
      {
        "value": "exampleValue"
      }
    ]
  }'

200

400

500

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

Successful operation

Delete Event Metric Mapping by Event Name

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

post

/entities/{entityId}/eventMetricMapping/eventName/{eventName}/delete

Path parameters

entityIdstringrequired

The ID of the entity.

Example: exampleEntityId

eventNamestringrequired

The name of the event.

Example: exampleEventName

Header parameters

apikeystringrequired

The API key for authentication

Example: test

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 \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/delete' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

500

{
  "success": true
}

Successful operation

Remove Metrics from Event Metric Mapping

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

post

/entities/{entityId}/eventMetricMapping/eventName/{eventName}/remove-metrics

Path parameters

entityIdstringrequired

The ID of the entity.

Example: exampleEntityId

eventNamestringrequired

The name of the event.

Example: exampleEventName

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

metricstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/remove-metrics' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "metric": "exampleMetric"
  }'

200

400

500

{
  "success": true
}

Successful operation

Create Many Event Metric Mappings

Create multiple event metric mappings.

post

/create-many/eventMetricMapping

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

dataobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/create-many/eventMetricMapping' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": [
      {
        "entityId": "exampleEntityId1",
        "eventName": "exampleEventName1",
        "platform": "examplePlatform1",
        "metrics": [
          "exampleMetric1"
        ],
        "properties": [
          {
            "value": "exampleValue1"
          }
        ]
      },
      {
        "entityId": "exampleEntityId2",
        "eventName": "exampleEventName2",
        "platform": "examplePlatform2",
        "metrics": [
          "exampleMetric2"
        ],
        "properties": [
          {
            "value": "exampleValue2"
          }
        ]
      }
    ]
  }'

201

500

{
  "success": true,
  "data": [
    {
      "entityId": "exampleEntityId1",
      "eventName": "exampleEventName1",
      "platform": "examplePlatform1",
      "metrics": [
        "exampleMetric1"
      ],
      "properties": [
        {
          "value": "exampleValue1"
        }
      ]
    },
    {
      "entityId": "exampleEntityId2",
      "eventName": "exampleEventName2",
      "platform": "examplePlatform2",
      "metrics": [
        "exampleMetric2"
      ],
      "properties": [
        {
          "value": "exampleValue2"
        }
      ]
    }
  ]
}

Successful operation