curl --request POST \
  --url https://api.peakmetrics.com/customEnrichments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Disinformation Analysis",
  "type": "categorical",
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed"
    ]
  }
}
'

{
  "enrichment_id": 1681,
  "name": "Disinformation Analysis",
  "type": "categorical",
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed"
    ]
  }
}

{
  "error": "'constraints.enum' must be [] for an integer enrichment — integer enrichments never have options"
}

{
  "error": "A custom enrichment named 'Disinformation Analysis' already exists for this team"
}

Custom Enrichments

Create a custom enrichment

Creates a custom enrichment for your team and returns its full definition — the same shape GET /customEnrichments lists — including the enrichment_id to use when pushing values with PUT /mentions/customEnrichments.

constraints.enum is required:

For categorical and multivalue_categorical enrichments it may be [] (create the enrichment with no options yet) or an array of initial option strings. Options are also registered automatically when PUT /mentions/customEnrichments writes a value that is not yet listed, up to 5000 per enrichment.
For integer enrichments it must be exactly [] — integer enrichments never have options.

POST

/

customEnrichments

curl --request POST \
  --url https://api.peakmetrics.com/customEnrichments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Disinformation Analysis",
  "type": "categorical",
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed"
    ]
  }
}
'

{
  "enrichment_id": 1681,
  "name": "Disinformation Analysis",
  "type": "categorical",
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed"
    ]
  }
}

{
  "error": "'constraints.enum' must be [] for an integer enrichment — integer enrichments never have options"
}

{
  "error": "A custom enrichment named 'Disinformation Analysis' already exists for this team"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

The display name. Must be unique among your team's custom enrichments (compared case-insensitively).

Maximum string length: 255

Example:

"Disinformation Analysis"

type

enum<string>

required

The data type of the enrichment's value. Cannot be changed after creation.

categorical — one string value per mention.
multivalue_categorical — several string values per mention on one field; PUT /mentions/customEnrichments takes an array.
integer — one integer value per mention.

Available options:

categorical,

multivalue_categorical,

integer

Example:

"categorical"

constraints

object

required

Show child attributes

Response

The created custom enrichment, in the same shape as GET /customEnrichments.

A custom enrichment definition, as listed by GET /customEnrichments.

enrichment_id

integer

The unique identifier. Use it as enrichment_id when pushing values with PUT /mentions/customEnrichments.

Example:

1681

name

string

The display name.

Example:

"Disinformation Analysis"

type

enum<string>

The data type of the enrichment's value. Fixed at creation.

Available options:

categorical,

multivalue_categorical,

integer

Example:

"categorical"

constraints

object

Show child attributes

⌘I