Event Metric Mapping

Get All Event Metric Mappings

get

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

/entities/{entityId}/eventMetricMapping

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

200

Successful operation

application/json

500

Internal Server Error

application/json

get

/entities/{entityId}/eventMetricMapping

HTTPcURLJavaScriptPython

GET /api/entities/{entityId}/eventMetricMapping HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*

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

Create Event Metric Mapping

post

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

/entities/{entityId}/eventMetricMapping

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

application/json

eventNamestringRequired

platformstringRequired

Responses

201

Successful operation

application/json

500

Server error

application/json

post

/entities/{entityId}/eventMetricMapping

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/eventMetricMapping HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "eventName": "text",
  "properties": [
    {
      "value": "text"
    }
  ],
  "platform": "text"
}

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

Get Event Metric Mapping by Event Name

get

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

200

Successful operation

application/json

400

EventMetricMapping not found

application/json

500

Server error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/entities/{entityId}/eventMetricMapping/eventName/{eventName} HTTP/1.1
Host: https:/.questprotocol.xyz
Accept: */*

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

Update Event Metric Mapping by Event Name

post

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

application/json

platformstringRequired

Responses

200

Successful operation

application/json

400

EventMetricMapping not found

application/json

500

Server error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/update HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "properties": [
    {
      "value": "exampleValue"
    }
  ],
  "platform": "examplePlatform"
}

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

Delete Event Metric Mapping by Event Name

post

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

200

Successful operation

application/json

400

EventMetricMapping not found

application/json

500

Server error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/delete HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*

{
  "success": true
}

Remove Metrics from Event Metric Mapping

post

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

application/json

metricstringRequired

Responses

200

Successful operation

application/json

400

EventMetricMapping not found

application/json

500

Server error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/eventMetricMapping/eventName/{eventName}/remove-metrics HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "metric": "exampleMetric"
}

{
  "success": true
}

Create Many Event Metric Mappings

post

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

/create-many/eventMetricMapping

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

application/json

Responses

201

Successful operation

application/json

500

Server error

application/json

post

/create-many/eventMetricMapping

HTTPcURLJavaScriptPython

POST /api/create-many/eventMetricMapping HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 338

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

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