Lytics API | Templates | Contentstack

List templates

GEThttps://api.lytics.io/v2/template

undefined

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

{
  "_meta": {},
  "data": [
    {
      "author_id": "string",
      "created": "string",
      "description": "string",
      "desired_format": "string",
      "field_filter": [
        "string"
      ],
      "id": "string",
      "lytics_managed": true,
      "name": "string",
      "reference_tables": [
        "string"
      ],
      "target": "string",
      "type": "string",
      "updated": "string"
    }
  ],
  "request_id": "string",
  "status": 0
}

Create a template

POSThttps://api.lytics.io/v2/template

undefined

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

namerequiredstring

The template name

descriptionoptionalstring

A description of the template

reference_tablesoptionalstring

Reference table slugs a js1 template may read via lytics.ref (max 5); sending the param empty clears them

typerequiredstring

The template type

Headers

Authorizationoptionalstring

Sample Request

"string"

Sample Response

Status|200 OK

{
  "_meta": {},
  "data": {
    "author_id": "string",
    "created": "string",
    "description": "string",
    "desired_format": "string",
    "field_filter": [
      "string"
    ],
    "id": "string",
    "lytics_managed": true,
    "name": "string",
    "reference_tables": [
      "string"
    ],
    "target": "string",
    "type": "string",
    "updated": "string"
  },
  "request_id": "string",
  "status": 0
}

Test a template

POSThttps://api.lytics.io/v2/template/test

undefined

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

entityoptionalobject

job_configoptionalobject

reference_tablesoptionalstring[]

ReferenceTables the adhoc template may read via lytics.ref; a saved template uses its own declaration.

sample_segmentsoptionalobject

sample_segments.asoptionalstring

where membership is surfaced to the template; omit for neither

One of: env, entity

sample_segments.namesoptionalstring[]

audience names the entity is in; sample slugs are approximated from these, not the stored slug

template_definitionoptionalstring

Adhoc template definition

template_targetoptionalstring

One of: stream, entql, enrich

template_typeoptionalstring

Adhoc template type

One of: jsonnet, handlebars, js1

Sample Request

{
  "entity": {},
  "job_config": {},
  "reference_tables": [
    "string"
  ],
  "sample_segments": {
    "as": "env",
    "names": [
      "string"
    ]
  },
  "template_definition": "string",
  "template_target": "stream",
  "template_type": "jsonnet"
}

Sample Response

Status|200 OK

"string"

Get a template

GEThttps://api.lytics.io/v2/template/{id}

undefined

Hide Parameters

URL Parameters

idrequiredstring

The template ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

{
  "_meta": {},
  "data": {
    "author_id": "string",
    "created": "string",
    "description": "string",
    "desired_format": "string",
    "field_filter": [
      "string"
    ],
    "id": "string",
    "lytics_managed": true,
    "name": "string",
    "reference_tables": [
      "string"
    ],
    "target": "string",
    "type": "string",
    "updated": "string"
  },
  "request_id": "string",
  "status": 0
}

Update a template

POSThttps://api.lytics.io/v2/template/{id}

undefined

Hide Parameters

URL Parameters

idrequiredstring

The template id

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

namerequiredstring

The template name

descriptionoptionalstring

A description of the template

reference_tablesoptionalstring

Reference table slugs a js1 template may read via lytics.ref (max 5); sending the param empty clears them

typerequiredstring

The template type

Headers

Authorizationoptionalstring

Sample Request

"string"

Sample Response

Status|200 OK

{
  "_meta": {},
  "data": {
    "author_id": "string",
    "created": "string",
    "description": "string",
    "desired_format": "string",
    "field_filter": [
      "string"
    ],
    "id": "string",
    "lytics_managed": true,
    "name": "string",
    "reference_tables": [
      "string"
    ],
    "target": "string",
    "type": "string",
    "updated": "string"
  },
  "request_id": "string",
  "status": 0
}

Delete template

DELETEhttps://api.lytics.io/v2/template/{id}

undefined

Hide Parameters

URL Parameters

idrequiredstring

The template ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

{
  "_meta": {},
  "data": {},
  "request_id": "string",
  "status": 0
}

Get a template definition

GEThttps://api.lytics.io/v2/template/{id}/definition

undefined

Hide Parameters

URL Parameters

idrequiredstring

The template ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

{
  "_meta": {},
  "data": "string",
  "request_id": "string",
  "status": 0
}

Test a template

POSThttps://api.lytics.io/v2/template/{id}/test

undefined

Hide Parameters

URL Parameters

idrequiredstring

The template id

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

entityoptionalobject

job_configoptionalobject

sample_segmentsoptionalobject

sample_segments.asoptionalstring

where membership is surfaced to the template; omit for neither

One of: env, entity

sample_segments.namesoptionalstring[]

audience names the entity is in; sample slugs are approximated from these, not the stored slug

Sample Request

{
  "entity": {},
  "job_config": {},
  "sample_segments": {
    "as": "env",
    "names": [
      "string"
    ]
  }
}

Sample Response

Status|200 OK

"string"