Lytics

Lytics Templates API

Create, manage, and test templates.

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /template List templates · List templates #
Ask an LLM
“Which export templates have been set up on my account?”
“Can I see every template in one list?”
Tell an agent
List all my templates.
Show the templates on account {account_id}.
POST /template Create a template · Create a template #
Ask an LLM
“How do I create a new template of a given type?”
“What name and type does a new template need?”
Tell an agent
Create a {type} template named {name}.
Create template {name} of type {type} described as {description}.
POST /template/test Test an unsaved template definition · Test a template #
Ask an LLM
“Can I try out a template definition before saving it?”
“What would a draft template render for a sample entity?”
Tell an agent
Test template definition {template_definition} against entity {entity}.
Dry-run an unsaved {template_type} template with sample segments {sample_segments}.
DELETE /template/{id} Delete a template · Delete template #
Ask an LLM
“How do I delete a template I no longer use?”
“Can a saved template be removed permanently?”
Tell an agent destructive · confirm first
Delete template {id}.
Permanently remove template {id} from my account.
GET /template/{id} Get one template · Get a template #
Ask an LLM
“Can I look up a single template by its id?”
“What name and type does a particular template have?”
Tell an agent
Show template {id}.
Fetch the metadata of template {id}.
POST /template/{id} Update a template's name or type · Update a template #
Ask an LLM
“Can I rename an existing template?”
“Is it possible to change a saved template's type or description?”
Tell an agent
Rename template {id} to {name}, keeping type {type}.
Update template {id} with name {name}, type {type} and description {description}.
GET /template/{id}/definition Get a template's definition body · Get a template definition #
Ask an LLM
“What does the actual body of a saved template contain?”
“Can I read the definition behind one template?”
Tell an agent
Show the definition of template {id}.
Print the template body for {id}.
POST /template/{id}/test Test a saved template · Test a template #
Ask an LLM
“Does a saved template render correctly for a sample entity?”
“Can I test an existing template with sample segments?”
Tell an agent
Test saved template {id} against entity {entity}.
Run existing template {id} with sample segments {sample_segments}.

Documentation

📖
Documentation
https://docs.lytics.com/reference
📖
APIReference
https://docs.lytics.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/openapi/lytics-templates-api-openapi.yml

Other Resources

🔗
OpenAPI Source
https://dash.readme.com/api/v1/api-registry/1y876emrv8pb2i
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/mcp/lytics-tool-crosswalk.yml
🔗
OpenAPI Source
https://dash.readme.com/api/v1/api-registry/10ej22ml8a94fx

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lytics:lytics-templates-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lytics-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@lytics.com
    name: Lytics Support
    url: https://support.lytics.com/hc/en-us
  description: Version 2 of the Lytics API
  termsOfService: https://www.lytics.com/terms-of-service/
  title: Lytics Templates API
  version: '2.0'
servers:
- url: https://api.lytics.io/v2
tags:
- description: Create, manage, and test templates.
  name: Templates
paths:
  /template:
    get:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      items:
                        $ref: '#/components/schemas/models.TemplateMetadata'
                      type: array
                  type: object
          description: Template Metadata
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: List templates
      tags:
      - Templates
      operationId: getTemplate
      x-operation-id-source: derived
    post:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The template name
        in: query
        name: name
        required: true
        schema:
          type: string
      - description: A description of the template
        in: query
        name: description
        schema:
          type: string
      - description: The template type
        in: query
        name: type
        required: true
        schema:
          enum:
          - '"jsonnet"'
          - '"handlebars"'
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              description: Adhoc template definition
              type: string
        description: The template definition
        required: true
        x-originalParamName: definition
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.TemplateMetadata'
                  type: object
          description: Template Metadata
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Create a template
      tags:
      - Templates
      operationId: postTemplate
      x-operation-id-source: derived
  /template/test:
    post:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/models.AdhocTemplateTestRequest'
        description: The template request
        required: true
        x-originalParamName: request
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: Template output
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Test a template
      tags:
      - Templates
      operationId: postTemplateTest
      x-operation-id-source: derived
  /template/{id}:
    delete:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The template ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Delete template
      tags:
      - Templates
      operationId: deleteTemplateById
      x-operation-id-source: derived
    get:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The template ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.TemplateMetadata'
                  type: object
          description: Template Metadata
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Get a template
      tags:
      - Templates
      operationId: getTemplateById
      x-operation-id-source: derived
    post:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The template id
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: The template name
        in: query
        name: name
        required: true
        schema:
          type: string
      - description: A description of the template
        in: query
        name: description
        schema:
          type: string
      - description: The template type
        in: query
        name: type
        required: true
        schema:
          enum:
          - '"jsonnet"'
          - '"handlebars"'
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              description: Adhoc template definition
              type: string
        description: The template definition
        required: true
        x-originalParamName: definition
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.TemplateMetadata'
                  type: object
          description: Template Metadata
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Update a template
      tags:
      - Templates
      operationId: postTemplateById
      x-operation-id-source: derived
  /template/{id}/definition:
    get:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The template ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      type: string
                  type: object
          description: Template Definition
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Get a template definition
      tags:
      - Templates
      operationId: getTemplateByIdDefinition
      x-operation-id-source: derived
  /template/{id}/test:
    post:
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The template id
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/models.TemplateTestRequest'
        description: The template request
        required: true
        x-originalParamName: request
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: Template output
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Test a template
      tags:
      - Templates
      operationId: postTemplateByIdTest
      x-operation-id-source: derived
components:
  schemas:
    models.TemplateTestRequest:
      properties:
        entity:
          additionalProperties: true
          type: object
        job_config:
          additionalProperties: true
          type: object
        sample_segments:
          $ref: '#/components/schemas/models.SampleSegmentsInput'
      type: object
    models.ApiErrorResponse:
      properties:
        errors:
          description: Lytics API Errors
          items:
            $ref: '#/components/schemas/lioerrors.ApiV2ErrorOut'
          type: array
        request_id:
          type: string
        status:
          description: HTTP Status Code
          type: integer
      type: object
    models.AdhocTemplateTestRequest:
      properties:
        entity:
          additionalProperties: true
          type: object
        job_config:
          additionalProperties: true
          type: object
        sample_segments:
          $ref: '#/components/schemas/models.SampleSegmentsInput'
        template_definition:
          description: Adhoc template definition
          type: string
        template_type:
          description: Adhoc template type
          enum:
          - jsonnet
          - handlebars
          type: string
      type: object
    models.SampleSegmentsInput:
      properties:
        as:
          description: where membership is surfaced to the template; omit for neither
          enum:
          - env
          - entity
          type: string
        names:
          description: audience names the entity is in; sample slugs are approximated from these, not the stored slug
          items:
            type: string
          type: array
      type: object
    models.ApiResponse:
      properties:
        _meta:
          additionalProperties: true
          description: Response Metadata
          type: object
        data:
          description: Response Payload
          type: object
        request_id:
          type: string
        status:
          description: HTTP Status Code
          type: integer
      type: object
    models.TemplateMetadata:
      properties:
        author_id:
          type: string
        created:
          type: string
        description:
          type: string
        desired_format:
          type: string
        field_filter:
          items:
            type: string
          type: array
        id:
          type: string
        lytics_managed:
          description: undocumented, sysadmin-use only
          type: boolean
        name:
          type: string
        target:
          type: string
        type:
          type: string
        updated:
          type: string
      type: object
    lioerrors.ApiV2ErrorOut:
      properties:
        code:
          description: Lytics Error Code
          enum:
          - UNKNOWN-000
          - BADREQ-001
          - JOB-BADREQ-002
          - NOTFOUND-003
          - JOB-NOTFOUND-004
          - WF-NOTFOUND-005
          - AUTH-NOTFOUND-006
          - AUTHTYPE-NOTFOUND-007
          - AUTH-BADREQ-008
          - TABLE-NOTFOUND-009
          - SCHEMA-NOTFOUND-010
          - SCHEMAVERSION-NOTFOUND-011
          - ENTITY-NOTFOUND-012
          - QUERY-NOTFOUND-013
          - STREAM-NOTFOUND-014
          - PROVIDER-BADREQ-015
          - PROVIDER-NOTFOUND-016
          - UNAUTHORIZED-017
          - SCHEMA-INVALID-018
          - INTERNAL-019
          - ROUTERULE-NOTFOUND-020
          - ACCOUNT-NOTFOUND-021
          - JOB-FAULT-022
          - USER-NOTFOUND-023
          - USER-BADREQ-024
          - JSON-BADREQ-025
          - FORBIDDEN-026
          type: string
        level:
          description: When the error was generated
          type: string
        message:
          description: A description of the error that occurred
          type: string
        timestamp:
          description: The time the error occurred
          format: date-time
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey