Evaluate features

POST

messaging

features

evaluate

Evaluate features

curl --request POST \
  --url https://api.polymorfa.com/messaging/features/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "surface": "<string>",
  "keys": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({surface: '<string>', keys: ['<string>']})
};

fetch('https://api.polymorfa.com/messaging/features/evaluate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/features/evaluate"

payload = {
    "surface": "<string>",
    "keys": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/features/evaluate"

	payload := strings.NewReader("{\n  \"surface\": \"<string>\",\n  \"keys\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": [
    {
      "decision": {
        "key": "<string>",
        "version": 123,
        "available": true,
        "enrolled": true,
        "variant": "<string>",
        "experimentRevision": 2,
        "experimentAssigned": true
      },
      "title": "<string>",
      "description": "<string>",
      "termsRevision": "<string>",
      "withdrawal": "<string>",
      "exposureToken": "<unknown>"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Body

application/json

surface

string

required

Specifies surface for this schema.

Value constraints

Constraint	Accepted input
String length	At most `100` characters
Pattern	`^[a-z][a-z0-9](?:[.-][a-z0-9]+)$`

Maximum string length: 100

Pattern: ^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$

keys

string[]

required

Keys associated with this schema.

Value constraints

Constraint	Accepted input
Array size	At most `50` items
Item string length	At most `100` characters
Item pattern	`^[a-z][a-z0-9](?:[.-][a-z0-9]+)$`

Maximum array length: 50

Maximum string length: 100

Pattern: ^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$

measurementAllowed

boolean

default:false

Whether measurement allowed.

Response

Feature decisions

success

enum<boolean>

required

Whether the request succeeded.

Allowed values

Value	Meaning
`true`	True.

Available options:

true

data

object[]

required

Structured data carried by this object.

Show child attributes

Evaluate features

curl --request POST \
  --url https://api.polymorfa.com/messaging/features/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "surface": "<string>",
  "keys": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({surface: '<string>', keys: ['<string>']})
};

fetch('https://api.polymorfa.com/messaging/features/evaluate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/features/evaluate"

payload = {
    "surface": "<string>",
    "keys": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/features/evaluate"

	payload := strings.NewReader("{\n  \"surface\": \"<string>\",\n  \"keys\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": [
    {
      "decision": {
        "key": "<string>",
        "version": 123,
        "available": true,
        "enrolled": true,
        "variant": "<string>",
        "experimentRevision": 2,
        "experimentAssigned": true
      },
      "title": "<string>",
      "description": "<string>",
      "termsRevision": "<string>",
      "withdrawal": "<string>",
      "exposureToken": "<unknown>"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Authorizations

Body

Response