Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ntropy personalization API

The personalization API from Ntropy — 6 operation(s) for personalization.

Ntropy personalization API is one of 16 APIs that Ntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include personalization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 6 paths, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ntropy.com.

10 operations 6 paths 44 schemas 2 DELETE2 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ntropy.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ntropy personalization API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

personalization 10
POST
/v3/rules
Create a rule.
filter-post-v-3-rules-post 1 param body → 200400413422
GET
/v3/rules
List all rules
filter-get-v-3-rules-get 1 param → 200422
POST
/v3/rules/replace
Replace all rules
filter-replace-v-3-rules-replace-post 1 param body → 200400413422
PATCH
/v3/rules/{id}
Modify an existing rule
filter-patch-v-3-rules-id-patch 2 params body → 200400422
DELETE
/v3/rules/{id}
Delete a rule
filter-delete-v-3-rules-id-delete 2 params → 200400422
GET
/v2/rules/
Get the current personalization ruleset.
filter_get_v2_rules__get → 200422
POST
/v2/rules/
Set the personalization ruleset.
filter_post_v2_rules__post body → 200400413422
POST
/v2/rules/append
Append a rule.
filter_append_v2_rules_append_post body → 200400413422
DELETE
/v2/rules/{index}
Delete a rule.
filter_delete_v2_rules__index__delete 1 param → 200400422
PATCH
/v2/rules/{index}
Modify an existing rule.
filter_patch_v2_rules__index__patch 1 param body → 200400422

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are ValidationError (3 properties), If (3 properties), ValidationError_2 (3 properties), Setter (2 properties). Each schema is shown below with its type and property counts.

FnCall13
object
1 property 1 required
FnCall18
object
1 property 1 required
ModifyLabels
FnCall20
object
1 property 1 required
ModifyLabels2
object
1 property 1 required
ValidationError
object
3 properties 3 required
FnCall2
object
1 property 1 required
FnCall17
object
1 property 1 required
FilterModel
array
FnCall5
object
1 property 1 required
ValidationError_2
object
3 properties 3 required
If
object
3 properties 1 required
FnCall9
object
1 property 1 required
FnCall3
object
1 property 1 required
FnCall14
object
1 property 1 required
Setter
object
2 properties 2 required
FilterModel_2
array
TxProp
string
FnCall15
object
1 property 1 required
FnCall
FnCall19
object
1 property 1 required
FnCall7
object
1 property 1 required
EditableTxProp
string
ModifyLabels5
object
1 property 1 required
FnCall11
object
1 property 1 required
FnCall4
object
1 property 1 required
ModifyLabels0
object
1 property 1 required
FnCall1
object
1 property 1 required
ModifyLabels1
object
1 property 1 required
HTTPValidationError_2
object
1 property
Action
FnCall6
object
1 property 1 required
ValidationErrorLocItems
ModifyLabels3
object
1 property 1 required
Action_2
object
FnCall10
object
1 property 1 required
HTTPValidationError
object
1 property
Expr
FnCall0
object
1 property 1 required
FnCall16
object
1 property 1 required
ActionModelOutput
object
1 property 1 required
ModifyLabels4
object
1 property 1 required
FnCall8
object
1 property 1 required
FnCall12
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-personalization-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements API
Ntropy bankStatements API
Ntropy batches API
Ntropy categories API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy recurrence API
Ntropy Reporting API