Event Metric Mapping

Get All Event Metric Mappings

get

Get all event metric mappings for a specific entity.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

500

200

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

Successful operation

Create Event Metric Mapping

post

Create a new event metric mapping for an entity.

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

propertiesobject[]required

platformstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
    "properties": [
      {
        "value": "text"
      }
    ],
    "platform": "text"
  }'

201

500

201

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

Successful operation

Get Event Metric Mapping by Event Name

get

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

Path parameters

entityIdstringrequired

The ID of the entity.

Example: exampleEntityId

eventNamestringrequired

The name of the event.

Example: exampleEventName

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

500

200

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

Successful operation

Update Event Metric Mapping by Event Name

post

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

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

propertiesobject[]required

platformstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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 '{
    "properties": [
      {
        "value": "exampleValue"
      }
    ],
    "platform": "examplePlatform"
  }'

200

400

500

200

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

Successful operation

Delete Event Metric Mapping by Event Name

post

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

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

{
  "success": true
}

Successful operation

Remove Metrics from Event Metric Mapping

post

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

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

{
  "success": true
}

Successful operation

Create Many Event Metric Mappings

post

Create multiple event metric mappings.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
        "properties": [
          {
            "value": "exampleValue1"
          }
        ],
        "metrics": [
          "exampleMetric1"
        ],
        "platform": "examplePlatform1"
      },
      {
        "entityId": "exampleEntityId2",
        "eventName": "exampleEventName2",
        "properties": [
          {
            "value": "exampleValue2"
          }
        ],
        "metrics": [
          "exampleMetric2"
        ],
        "platform": "examplePlatform2"
      }
    ]
  }'

201

500

201

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

Successful operation