Working with the NEON APIs

Connecting to the APIs
What API to use
General notes about Json bodies and responses
The NEON Loyalty API
The NEON Config API
The NEON Interact API

Working with the Loyalty API

Introduction
Query (GET) Endpoints
Pagination and Sorting
Filtering to limit query results
Save (POST) Endpoints
Response Payloads
Error Responses
Standard Fields

NEON Loyalty API

Activities
Loyalty API Admin Support
CMS
- Get Cms contentget
- Query CMS Document Resourcesget
Codes
Competitions
Custom events
Tasks
Forms
Funnels
Games
Journeys
Lists
Members
Messages
Offers
Orders
Relationships
Sheets
Surveys
Votes
Wallets
Reporting
Target Expressions

NEON Interact API

Forms
- Save an eventpost
Links
- Track and Redirect a Linkget

NEON Config API

Welcome to the Config API
Entity Config
CMS Content Config
CMS Definition Config
CMS Document Config
Code Bank Config
Code Bank Administration
Code Set Config
Code Set Administration
- Query Code Set Codesget
- Add multiple Code Set Codespost
Competition Config
Custom Entities Config
Dimension Config
Form Config
Funnel Config
Game Config
Job Config
Job Administration
Journey Config
List Config
Member Config
Message Config
Offer Config
Order Set Config
Relationship Config
Sheet Config
Survey Config
User Role Config
User Administration
User Authentication
Vote Config
Wallet Config

Working with the NEON APIs

Connecting to the APIs
What API to use
General notes about Json bodies and responses
The NEON Loyalty API
The NEON Config API
The NEON Interact API

Working with the Loyalty API

Introduction
Query (GET) Endpoints
Pagination and Sorting
Filtering to limit query results
Save (POST) Endpoints
Response Payloads
Error Responses
Standard Fields

NEON Loyalty API

Activities
Loyalty API Admin Support
CMS
- Get Cms contentget
- Query CMS Document Resourcesget
Codes
Competitions
Custom events
Tasks
Forms
Funnels
Games
Journeys
Lists
Members
Messages
Offers
Orders
Relationships
Sheets
Surveys
Votes
Wallets
Reporting
Target Expressions

NEON Interact API

Forms
- Save an eventpost
Links
- Track and Redirect a Linkget

NEON Config API

Welcome to the Config API
Entity Config
CMS Content Config
CMS Definition Config
CMS Document Config
Code Bank Config
Code Bank Administration
Code Set Config
Code Set Administration
- Query Code Set Codesget
- Add multiple Code Set Codespost
Competition Config
Custom Entities Config
Dimension Config
Form Config
Funnel Config
Game Config
Job Config
Job Administration
Journey Config
List Config
Member Config
Message Config
Offer Config
Order Set Config
Relationship Config
Sheet Config
Survey Config
User Role Config
User Administration
User Authentication
Vote Config
Wallet Config

Parses/Validates an Expression

post https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/target-expressions/parse

This method validates a passed in Target Expression, but does not carry out any processing.
The same Expression is returned, along with additional meta data. If the expression already exists in the database, the response will
also return status information about each step.

Path Params

space

string

required

The name of the space (database) assigned to you.

Body Params

steps

array of objects

The steps to execute and the order in which they should be processed

steps

Response

Response body

object

steps

array of objects

The steps to execute and the order in which they should be processed

steps

object

type

string

required

The type of step

BASE_LIST LIST_FILTER FIELD_FILTER ENGAGEMENT_FILTER ACTIVITY_FILTER

operation

string

The operation to carry out, differs depending on the type of step

ALL ANY NONE

entities

array of objects

What entity or entities the step operates on. May support more than one entity, depending on the step type

entities

object

entityId

string

Returns the EntityId. When saving, it accepts a lookupId.

entityInfo

object

Additional information about the Entity

entityType

string

Some step types may allow an entity type to be specified instead of a list of entities.

CMS_DEFINITION CMS_DOCUMENT CODE_BANK CODE_SET COMPETITION CUSTOM DIMENSION FORM FUNNEL GAME JOB JOURNEY LIST MEMBER MESSAGE_SERVER MESSAGE_TEMPLATE OFFER ORDER_SET RELATIONSHIP SHEET SURVEY USER_ROLE VOTE WALLET

fieldFilter

object

Fields and their values to be used as part of the filter. The field values allow query expressions.

Has additional fields

dimensionFilter

object

Used together wth step types that allow dimension filters. The Dimension filters support query expressions

Has additional fields

cumulativeStatus

object

The status and number of members for all steps up to an including this step.

The status is not returned if the step or combinations of steps hasn't been processed before. Since the processing goes on
in the background, querying the method again at a later time may return the result.

debugExpression

string

For internal use only. May be removed.

Updated 5 months ago

Entity Stats Trend Report

Process an Expression

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://neon-loyalty-qa.spika.com/loyalty/v1/space/target-expressions/parse \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 5 months ago

Entity Stats Trend Report

Process an Expression

Did this page help you?

Working with the NEON APIs
Connecting to the APIs
What API to use
General notes about Json bodies and responses
The NEON Loyalty API
The NEON Config API
The NEON Interact API

Working with the Loyalty API
Introduction
Query (GET) Endpoints
Pagination and Sorting
Filtering to limit query results
Query Expressions
Querying by Entity Lookup Id
Querying by Member Lookup Id
Save (POST) Endpoints
Response Payloads
Error Responses
Standard Fields

NEON Loyalty API
Activities
Save multiple Activitiespost
Save a new Activitypost
Query Activitiesget
Loyalty API Admin Support
Execute a script-templatepost
Execute a, SQL script-templatepost
Execute a script-expressionpost
CMS
Query CMS Document Resourcesget
Get Cms contentget
Codes
Query Codes by Memberget
Redeem a Codepost
View Codeget
Query Codesget
Pick a Codepost
Query Code Set Resourcesget
Competitions
Query Competitions by Memberget
Save multiple Entriespost
Submit or update an entrypost
Query Entriesget
Query Competition Resourcesget
Custom events
Submit multiple Custom eventspost
Submit a Custom eventpost
Query Custom Resourcesget
Tasks
View Task errorsget
Abort Item Taskpost
Generate File URLget
Save an import Task to queuepost
Query Task queueget
View Task errorsget
Generate File URLpost
Abort Item Taskpost
Save an export Task to queuepost
Query Task queueget
Forms
View Form Memberget
Submit multiple Form Memberspost
Submit Form Memberpost
Query Form Membersget
Query Form Resourcesget
Funnels
Query Funnels by Memberget
Save multiple Stepspost
Save a Steppost
Query Stepsget
View Funnel Memberget
Query Membersget
Query Funnel Resourcesget
Games
Query Games by Memberget
View Game playget
Submit multiple Game playspost
Save Game playpost
Query Game playsget
Query Highscoresget
Query Game Resourcesget
Journeys
Query Journeys by Memberget
View Journey Memberget
Start multiple Journeyspost
Start a Journeypost
Query Journey Membersget
Query Journey Resourcesget
Lists
Query Lists by Memberget
View List itemget
Save multiple List itemspost
Save List Itempost
Query List itemget
Copies Members into new Listspost
Set List column valuespost
Remove List Memberspost
Manipulate a List from another Listpost
Clone a Listpost
Query List resourcesget
Members
Delete a Memberdelete
View Memberget
Save multiple Memberspost
Save a Memberpost
Query Membersget
Messages
View Messageget
Query Messagesget
Send multiple Messagespost
Send a Messagepost
Query Message Template Resourcesget
Query Messages by Memberget
Offers
Query Offer instancesget
Claim an Offerpost
Query Offer Resourcesget
Query Offer by Memberget
Query Offers by Memberget
Orders
Save Paymentpost
Query Paymentsget
View Orderget
Save Orderpost
Query Ordersget
Query Order Linesget
Query Payments by Memberget
Query Orders by Memberget
Relationships
Save multiple Relationshipspost
Save Relationshippost
Query Relationshipsget
Query Relationship Resourcesget
Query Relationships by Memberget
Sheets
View Sheet Rowget
Save multiple Rowspost
Save Sheet Rowpost
Query Sheet rowsget
Query Sheet Resourcesget
Query Sheets by Memberget
Surveys
View Survey entryget
Submit multiple Surveyspost
Submit Surveypost
Query Survey entriesget
Query Survey Resourcesget
Query Surveys by Memberget
Votes
View Vote entryget
Submit multiple Votespost
Submit Votepost
Query Vote entriesget
Query Vote Resourcesget
Query Votes by Memberget
Wallets
Query Wallet transactionsget
View Walletget
Query Walletsget
Submit multiple Transactionspost
Save Wallet Transactionpost
Query Wallets by Memberget
Reporting
Entity Stats Trend Reportget
Entity Stats Reportget
Dimension Value Entities Reportget
Dimension Values Reportget
Dimension combination Entities Reportget
Dimension Combinations Reportget
Database Table Size Reportget
Database Table Definition Reportget
Target Expressions
Resets an INVALID steppost
Modify a Tag List based on a Targetpost
Export Target Expression Membersget
Process an Expressionpost
Parses/Validates an Expressionpost

NEON Interact API
Forms
Save an eventpost
Links
Track and Redirect a Linkget

NEON Config API
Welcome to the Config API
Entity Config
Query Entity referencesget
Update Entityput
Patch Entitypatch
View Entityget
List field valuesget
Bulk load Entitiespost
Add Entitypost
Query Entitiesget
CMS Content Config
Delete CMS Contentdelete
Save CMS Contentpost
Query CMS Contentget
CMS Definition Config
Update CMS Definitionput
Patch CMS Definitionpatch
View CMS Definitionget
Delete CMS Definitiondelete
Add CMS Definitionpost
Query CMS Definitionsget
CMS Document Config
Update CMS Documentput
Patch CMS Documentpatch
View CMS Documentget
Delete CMS Documentdelete
Add CMS Documentpost
Query CMS Documentsget
Code Bank Config
Update Code Bankput
Patch Code Bankpatch
View Code Bankget
Delete Code Bankdelete
Add Code Bankpost
Query Code Banksget
Code Bank Administration
View Code Bank Codeget
Query Code Bank Codesget
Query Code Batchesget
Code Set Config
Update Code Setput
Patch Code Setpatch
View Code Setget
Delete Code Setdelete
Add Code Setpost
Query Code Setsget
Code Set Administration
Add multiple Code Set Codespost
Query Code Set Codesget
Competition Config
Update Competitionput
Patch Competitionpatch
View Competitionget
Delete Competitiondelete
Add Competitionpost
Query Competitionsget
Custom Entities Config
Update Custom Entityput
Patch Custom Entitypatch
View Custom Entityget
Delete Custom Entitydelete
Add Custom Entitypost
Query Custom Entitiesget
Dimension Config
Update Dimensionput
Patch Dimensionpatch
View Dimensionget
Delete Dimensiondelete
Update Dimension Valueput
View Dimension Valueget
Delete Dimension Valuedelete
Add Dimension Valuepost
Query Dimension Valuesget
Add Dimensionpost
Query Dimensionsget
Form Config
Update Formput
Patch Formpatch
View Formget
Delete Formdelete
Add Formpost
Query Formsget
Funnel Config
Update Funnelput
Patch Funnelpatch
View Funnelget
Delete Funneldelete
Add Funnelpost
Query Funnelsget
Game Config
Update Gameput
Patch Gamepatch
View Gameget
Delete Gamedelete
Add Gamepost
Query Gamesget
Job Config
Update Jobput
Patch Jobpatch
View Jobget
Delete Jobdelete
Add Jobpost
Query Jobsget
Job Administration
Run the Job Nowpost
Reset Jobpost
Query Job Logsget
Disable Jobpost
Journey Config
Update Journeyput
Patch Journeypatch
View Journeyget
Delete Journeydelete
Add Journeypost
Query Journeysget
List Config
Update Listput
Patch Listpatch
View Listget
Delete Listdelete
Add Listpost
Query Listsget
Member Config
Update Member configurationput
Patch Member configurationpatch
Get Member configurationget
Message Config
Update Message Templateput
Patch Message Templatepatch
View Message Templateget
Delete Message Templatedelete
Add Message Templatepost
Query Message Templatesget
Update Message Serverput
Patch Message Serverpatch
View Message Serverget
Delete Message Serverdelete
Add Message Serverpost
Query Message Serversget
Offer Config
Update Offerput
Patch Offerpatch
View Offerget
Delete Offerdelete
Add Offerpost
Query Offersget
Order Set Config
Update Order Setput
Patch Order Setpatch
View Order Setget
Delete Order Setdelete
Add Order Setpost
Query Order Setsget
Relationship Config
Update Relationshipput
Patch Relationshippatch
View Relationshipget
Delete Relationshipdelete
Add Relationshippost
Query Relationshipsget
Sheet Config
Update Property Sheet Propertyput
View Property Sheet Propertyget
Delete Property Sheet Propertydelete
Add Property Sheet Propertypost
Query Property Sheet Propertiesget
Update Sheetput
Patch Sheetpatch
View Sheetget
Delete Sheetdelete
Add Sheetpost
Query Sheetsget
Survey Config
Update Surveyput
Patch Surveypatch
View Surveyget
Delete Surveydelete
Add Surveypost
Query Surveysget
User Role Config
Update User Roleput
Patch User Rolepatch
View User Roleget
Delete User Roledelete
Add User Rolepost
Query User Rolesget
User Administration
Change my passwordpost
Update Userpost
View Userget
List assignable Usersget
Create Userpost
Query Usersget
User Authentication
Revoke an access keypost
Generate a new access keypost
Edit an access keypost
Query a User's access keysget
Authenticate credentialspost
Vote Config
Update Voteput
Patch Votepatch
View Voteget
Delete Votedelete
Add Votepost
Query Votesget
Wallet Config
Update Walletput
Patch Walletpatch
View Walletget
Delete Walletdelete
Add Walletpost
Query Walletsget

Working with the NEON APIs
Connecting to the APIs
What API to use
General notes about Json bodies and responses
The NEON Loyalty API
The NEON Config API
The NEON Interact API

Working with the Loyalty API
Introduction
Query (GET) Endpoints
Pagination and Sorting
Filtering to limit query results
Query Expressions
Querying by Entity Lookup Id
Querying by Member Lookup Id
Save (POST) Endpoints
Response Payloads
Error Responses
Standard Fields

NEON Loyalty API
Activities
Save multiple Activitiespost
Save a new Activitypost
Query Activitiesget
Loyalty API Admin Support
Execute a script-templatepost
Execute a, SQL script-templatepost
Execute a script-expressionpost
CMS
Query CMS Document Resourcesget
Get Cms contentget
Codes
Query Codes by Memberget
Redeem a Codepost
View Codeget
Query Codesget
Pick a Codepost
Query Code Set Resourcesget
Competitions
Query Competitions by Memberget
Save multiple Entriespost
Submit or update an entrypost
Query Entriesget
Query Competition Resourcesget
Custom events
Submit multiple Custom eventspost
Submit a Custom eventpost
Query Custom Resourcesget
Tasks
View Task errorsget
Abort Item Taskpost
Generate File URLget
Save an import Task to queuepost
Query Task queueget
View Task errorsget
Generate File URLpost
Abort Item Taskpost
Save an export Task to queuepost
Query Task queueget
Forms
View Form Memberget
Submit multiple Form Memberspost
Submit Form Memberpost
Query Form Membersget
Query Form Resourcesget
Funnels
Query Funnels by Memberget
Save multiple Stepspost
Save a Steppost
Query Stepsget
View Funnel Memberget
Query Membersget
Query Funnel Resourcesget
Games
Query Games by Memberget
View Game playget
Submit multiple Game playspost
Save Game playpost
Query Game playsget
Query Highscoresget
Query Game Resourcesget
Journeys
Query Journeys by Memberget
View Journey Memberget
Start multiple Journeyspost
Start a Journeypost
Query Journey Membersget
Query Journey Resourcesget
Lists
Query Lists by Memberget
View List itemget
Save multiple List itemspost
Save List Itempost
Query List itemget
Copies Members into new Listspost
Set List column valuespost
Remove List Memberspost
Manipulate a List from another Listpost
Clone a Listpost
Query List resourcesget
Members
Delete a Memberdelete
View Memberget
Save multiple Memberspost
Save a Memberpost
Query Membersget
Messages
View Messageget
Query Messagesget
Send multiple Messagespost
Send a Messagepost
Query Message Template Resourcesget
Query Messages by Memberget
Offers
Query Offer instancesget
Claim an Offerpost
Query Offer Resourcesget
Query Offer by Memberget
Query Offers by Memberget
Orders
Save Paymentpost
Query Paymentsget
View Orderget
Save Orderpost
Query Ordersget
Query Order Linesget
Query Payments by Memberget
Query Orders by Memberget
Relationships
Save multiple Relationshipspost
Save Relationshippost
Query Relationshipsget
Query Relationship Resourcesget
Query Relationships by Memberget
Sheets
View Sheet Rowget
Save multiple Rowspost
Save Sheet Rowpost
Query Sheet rowsget
Query Sheet Resourcesget
Query Sheets by Memberget
Surveys
View Survey entryget
Submit multiple Surveyspost
Submit Surveypost
Query Survey entriesget
Query Survey Resourcesget
Query Surveys by Memberget
Votes
View Vote entryget
Submit multiple Votespost
Submit Votepost
Query Vote entriesget
Query Vote Resourcesget
Query Votes by Memberget
Wallets
Query Wallet transactionsget
View Walletget
Query Walletsget
Submit multiple Transactionspost
Save Wallet Transactionpost
Query Wallets by Memberget
Reporting
Entity Stats Trend Reportget
Entity Stats Reportget
Dimension Value Entities Reportget
Dimension Values Reportget
Dimension combination Entities Reportget
Dimension Combinations Reportget
Database Table Size Reportget
Database Table Definition Reportget
Target Expressions
Resets an INVALID steppost
Modify a Tag List based on a Targetpost
Export Target Expression Membersget
Process an Expressionpost
Parses/Validates an Expressionpost

NEON Interact API
Forms
Save an eventpost
Links
Track and Redirect a Linkget

NEON Config API
Welcome to the Config API
Entity Config
Query Entity referencesget
Update Entityput
Patch Entitypatch
View Entityget
List field valuesget
Bulk load Entitiespost
Add Entitypost
Query Entitiesget
CMS Content Config
Delete CMS Contentdelete
Save CMS Contentpost
Query CMS Contentget
CMS Definition Config
Update CMS Definitionput
Patch CMS Definitionpatch
View CMS Definitionget
Delete CMS Definitiondelete
Add CMS Definitionpost
Query CMS Definitionsget
CMS Document Config
Update CMS Documentput
Patch CMS Documentpatch
View CMS Documentget
Delete CMS Documentdelete
Add CMS Documentpost
Query CMS Documentsget
Code Bank Config
Update Code Bankput
Patch Code Bankpatch
View Code Bankget
Delete Code Bankdelete
Add Code Bankpost
Query Code Banksget
Code Bank Administration
View Code Bank Codeget
Query Code Bank Codesget
Query Code Batchesget
Code Set Config
Update Code Setput
Patch Code Setpatch
View Code Setget
Delete Code Setdelete
Add Code Setpost
Query Code Setsget
Code Set Administration
Add multiple Code Set Codespost
Query Code Set Codesget
Competition Config
Update Competitionput
Patch Competitionpatch
View Competitionget
Delete Competitiondelete
Add Competitionpost
Query Competitionsget
Custom Entities Config
Update Custom Entityput
Patch Custom Entitypatch
View Custom Entityget
Delete Custom Entitydelete
Add Custom Entitypost
Query Custom Entitiesget
Dimension Config
Update Dimensionput
Patch Dimensionpatch
View Dimensionget
Delete Dimensiondelete
Update Dimension Valueput
View Dimension Valueget
Delete Dimension Valuedelete
Add Dimension Valuepost
Query Dimension Valuesget
Add Dimensionpost
Query Dimensionsget
Form Config
Update Formput
Patch Formpatch
View Formget
Delete Formdelete
Add Formpost
Query Formsget
Funnel Config
Update Funnelput
Patch Funnelpatch
View Funnelget
Delete Funneldelete
Add Funnelpost
Query Funnelsget
Game Config
Update Gameput
Patch Gamepatch
View Gameget
Delete Gamedelete
Add Gamepost
Query Gamesget
Job Config
Update Jobput
Patch Jobpatch
View Jobget
Delete Jobdelete
Add Jobpost
Query Jobsget
Job Administration
Run the Job Nowpost
Reset Jobpost
Query Job Logsget
Disable Jobpost
Journey Config
Update Journeyput
Patch Journeypatch
View Journeyget
Delete Journeydelete
Add Journeypost
Query Journeysget
List Config
Update Listput
Patch Listpatch
View Listget
Delete Listdelete
Add Listpost
Query Listsget
Member Config
Update Member configurationput
Patch Member configurationpatch
Get Member configurationget
Message Config
Update Message Templateput
Patch Message Templatepatch
View Message Templateget
Delete Message Templatedelete
Add Message Templatepost
Query Message Templatesget
Update Message Serverput
Patch Message Serverpatch
View Message Serverget
Delete Message Serverdelete
Add Message Serverpost
Query Message Serversget
Offer Config
Update Offerput
Patch Offerpatch
View Offerget
Delete Offerdelete
Add Offerpost
Query Offersget
Order Set Config
Update Order Setput
Patch Order Setpatch
View Order Setget
Delete Order Setdelete
Add Order Setpost
Query Order Setsget
Relationship Config
Update Relationshipput
Patch Relationshippatch
View Relationshipget
Delete Relationshipdelete
Add Relationshippost
Query Relationshipsget
Sheet Config
Update Property Sheet Propertyput
View Property Sheet Propertyget
Delete Property Sheet Propertydelete
Add Property Sheet Propertypost
Query Property Sheet Propertiesget
Update Sheetput
Patch Sheetpatch
View Sheetget
Delete Sheetdelete
Add Sheetpost
Query Sheetsget
Survey Config
Update Surveyput
Patch Surveypatch
View Surveyget
Delete Surveydelete
Add Surveypost
Query Surveysget
User Role Config
Update User Roleput
Patch User Rolepatch
View User Roleget
Delete User Roledelete
Add User Rolepost
Query User Rolesget
User Administration
Change my passwordpost
Update Userpost
View Userget
List assignable Usersget
Create Userpost
Query Usersget
User Authentication
Revoke an access keypost
Generate a new access keypost
Edit an access keypost
Query a User's access keysget
Authenticate credentialspost
Vote Config
Update Voteput
Patch Votepatch
View Voteget
Delete Votedelete
Add Votepost
Query Votesget
Wallet Config
Update Walletput
Patch Walletpatch
View Walletget
Delete Walletdelete
Add Walletpost
Query Walletsget

200OK