Taffrail.com
API Reference

Advice

get
https://engine.taffrail.com/api/advice/

Taffrail has a suite of APIs yet only one endpoint is necessary for most implementations. This single endpoint is known simply as the "Advice API".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the Advice Set

Query Params
params
object

Add arbitrary query parameters to the API. This is necessary to send name/value pairs to Taffrail, such as the Variable Marital_Status as married.

string
enum

Optional API context, use only when instructed.

Allowed:
fields
object

JSONAPI-style sparse fieldsets. Use ?[field]=prop1,prop2 to limit returned fields or ?[field]= to return no data for that property. Omitting the fields querystring parameter entirely defaults to all properties being returned.

filter
array of strings

Filter variables included in the response using 3 keywords in array bracket notation.

filter
include
array of strings

Include additional data, including debugging data. Do not use in Production.

include
Headers
integer
enum
required
Defaults to 2
Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.taffrail.json+text
application/vnd.taffrail.json+html
application/vnd.taffrail.json+htmlnolinks
application/vnd.taffrail.json+attrstring
application/vnd.taffrail.json+raw
application/json

Updated about 2 months ago