Public REST/JSON reference

Trial Convert API

Score trial users on conversion likelihood, define product activation milestones, watch the funnel for drop-offs, identify which users are stalled (and why), and trigger nudge sequences. Track per-sequence performance against trial-to-paid conversion lift. Part of the Logic Igniter SaaS Growth & Retention bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/trialconvert.json

Operations rendered

Response models rendered

GET/api/v1/trialconvert/customers

List customers

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CustomersResponse

Page of customers

401Error

Missing or invalid API key.

POST/api/v1/trialconvert/customers

Provision a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CreateCustomerRequest

Sample JSON payload for evaluation.

{
  "email": "[email protected]",
  "name": "Example Inc."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/trialconvert/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Example Inc."}'

Responses

201Customer

Customer created or returned

400Error

Invalid email or missing name

401Error

Missing or invalid API key.

GET/api/v1/trialconvert/customers/{id}

Get a customer by id

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Customer

Customer record

401Error

Missing or invalid API key.

404Error

Customer not found

PUT/api/v1/trialconvert/customers/{id}

Update a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request body (required)

Schema: UpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/trialconvert/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200Customer

Updated customer

400Error

Invalid update

401Error

Missing or invalid API key.

404Error

Customer not found

GET/api/v1/trialconvert/trials

List trial users

Workspace-wide list. Each user carries their TrialStatus (TRIAL/CONVERTED/EXPIRED), current conversion_score, and trial start/end timestamps.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/trials" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200TrialUsersResponse

Page of trial users

401Error

Missing or invalid API key.

GET/api/v1/trialconvert/trials/{id}

Get a trial user with milestone progress

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/trials/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200TrialUserDetail

Trial user detail

401Error

Missing or invalid API key.

404Error

User not found

POST/api/v1/trialconvert/trials/{id}/score

Re-score a trial user's conversion likelihood

Trigger an immediate re-scoring using the latest milestone progress + behavioral signals. Returns the new score (0–100). Useful right after a known signal change (just completed a milestone, etc.).

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/trialconvert/trials/:id/score" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ConversionScore

Conversion score

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers trial-user listing + funnel; paid plans unlock scoring, gap detection, attribution, sequence triggering.

404Error

User not found

GET/api/v1/trialconvert/milestones

List milestones

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/milestones" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200MilestonesResponse

Milestones in order

401Error

Missing or invalid API key.

POST/api/v1/trialconvert/milestones

Define an activation milestone

Map a product event to a milestone (e.g. `project.created` after the user creates their first project). `required_count` lets you require multiple occurrences before considering the milestone reached.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: DefineMilestoneRequest

Sample JSON payload for evaluation.

{
  "name": "first-project",
  "event_name": "project.created",
  "required_count": 1,
  "order": 1
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/trialconvert/milestones" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"first-project","event_name":"project.created","required_count":1,"order":1}'

Responses

201Milestone

Milestone created

400Error

Missing name or invalid order

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers trial-user listing + funnel; paid plans unlock scoring, gap detection, attribution, sequence triggering.

GET/api/v1/trialconvert/funnel

Activation funnel

Per-milestone users_reached + conversion_pct (% of users who reach the previous step that also reach this one). Standard view for finding the highest-leverage step to fix.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/funnel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ActivationFunnel

Funnel data

401Error

Missing or invalid API key.

GET/api/v1/trialconvert/gaps

Identify activation gaps

Workspace-wide list of users with activation gaps, labelled by GapType (STALLED_MILESTONE / NEVER_STARTED / DROPPED_OFF / SLOW_PROGRESS). The list to drive the next nudge campaign.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/gaps" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200GapsResponse

Activation gaps

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers trial-user listing + funnel; paid plans unlock scoring, gap detection, attribution, sequence triggering.

GET/api/v1/trialconvert/metrics

Conversion metrics

Top-line: trial_to_paid_rate, total_trials, total_conversions, avg_days_to_convert. Optional `cohort` query filter (e.g. plan, signup source).

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`cohort`	query	string	Optional cohort key (e.g. "plan-pro").

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/metrics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ConversionMetrics

Conversion metrics

401Error

Missing or invalid API key.

POST/api/v1/trialconvert/attribution/{id}

Attribute a user's conversion

Returns the sequence that converted the user (last-touch attribution) plus the milestone path they walked. Useful for ROAS reports per nudge sequence.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/trialconvert/attribution/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200AttributionResult

Attribution result

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers trial-user listing + funnel; paid plans unlock scoring, gap detection, attribution, sequence triggering.

404Error

User not found

POST/api/v1/trialconvert/sequences/trigger

Trigger a nudge sequence for a user

Starts a named sequence. Each step's status moves through SENT → OPENED → CLICKED as the user interacts with the email/in-app messages.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: TriggerSequenceRequest

Sample JSON payload for evaluation.

{
  "user_id": "11111111-1111-1111-1111-111111111111",
  "sequence_id": "first-week-onboarding"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/trialconvert/sequences/trigger" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"11111111-1111-1111-1111-111111111111","sequence_id":"first-week-onboarding"}'

Responses

200TriggerResult

Sequence triggered

400Error

Missing user_id or sequence_id

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers trial-user listing + funnel; paid plans unlock scoring, gap detection, attribution, sequence triggering.

404Error

User or sequence not found

GET/api/v1/trialconvert/sequences

List active sequences

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/sequences" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SequencesResponse

Page of active sequences

401Error

Missing or invalid API key.

GET/api/v1/trialconvert/sequences/{id}/performance

Per-sequence performance

open_rate / click_rate / conversion_rate / total_sent for a single sequence — the data your growth team uses to A/B test sequence variants.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/trialconvert/sequences/:id/performance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SequencePerformance

Sequence performance

401Error

Missing or invalid API key.

404Error

Sequence not found

Data models

Error

Field	Type	Notes
`error`required	string

TrialStatus

GapType

SequenceStatus

TrialUserSummary

Field	Type	Notes
`status`	TrialStatus
`conversion_score`	number (double)
`trial_start`	string (date-time)
`trial_end`	string (date-time)

TrialUsersResponse

Field	Type	Notes
`items`	array<TrialUserSummary>
`next_page_token`	string
`total_count`	integer

MilestoneProgress

Field	Type	Notes
`milestone_id`	string (uuid)
`name`	string
`completed`	boolean
`completed_at`	string (date-time)

TrialUserDetail

Field	Type	Notes
`status`	TrialStatus
`conversion_score`	number (double)
`milestones`	array<MilestoneProgress>
`trial_start`	string (date-time)
`trial_end`	string (date-time)

ConversionScore

Field	Type	Notes
`id`	string (uuid)
`user_id`	string (uuid)
`score`	number (double)
`scored_at`	string (date-time)

DefineMilestoneRequest

Field	Type	Notes
`name`required	string
`event_name`required	string
`required_count`	integer
`order`required	integer

Milestone

Field	Type	Notes
`id`	string (uuid)
`name`	string
`event_name`	string
`required_count`	integer
`order`	integer

MilestonesResponse

Field	Type	Notes
`items`	array<Milestone>

FunnelStep

Field	Type	Notes
`milestone_id`	string (uuid)
`name`	string
`users_reached`	integer
`conversion_pct`	number (double)

ActivationFunnel

Field	Type	Notes
`id`	string (uuid)
`steps`	array<FunnelStep>

ActivationGap

Field	Type	Notes
`user_id`	string (uuid)
`email`	string (email)
`milestone_id`	string (uuid)
`gap_type`	GapType
`days_stalled`	integer

GapsResponse

Field	Type	Notes
`items`	array<ActivationGap>

ConversionMetrics

Field	Type	Notes
`id`	string (uuid)
`trial_to_paid_rate`	number (double)
`total_trials`	integer
`total_conversions`	integer
`avg_days_to_convert`	number (double)

AttributionResult

Field	Type	Notes
`id`	string (uuid)
`user_id`	string (uuid)
`attributed_sequence_id`	string (uuid)
`milestone_path`	array<string>

TriggerSequenceRequest

Field	Type	Notes
`user_id`required	string (uuid)
`sequence_id`required	string

TriggerResult

Field	Type	Notes
`id`	string (uuid)
`success`	boolean

ActiveSequence

Field	Type	Notes
`id`	string (uuid)
`user_id`	string (uuid)
`sequence_name`	string
`current_step`	integer
`status`	SequenceStatus

SequencesResponse

Field	Type	Notes
`items`	array<ActiveSequence>
`next_page_token`	string
`total_count`	integer

SequencePerformance

Field	Type	Notes
`id`	string (uuid)
`open_rate`	number (double)
`click_rate`	number (double)
`conversion_rate`	number (double)
`total_sent`	integer

CreateCustomerRequest

Field	Type	Notes
`email`required	string (email)
`name`required	string

UpdateCustomerRequest

Field	Type	Notes
`email`	string (email)
`name`	string

Customer

Field	Type	Notes
`id`	string (uuid)
`email`	string (email)
`name`	string
`created_at`	string (date-time)

CustomersResponse

Field	Type	Notes
`items`	array<Customer>
`next_page_token`	string
`total_count`	integer