A landing page is the public way that the individuals interact with your application and create an account.
Landing pages are identified by a unique path: if a landing page and a redirect are both defined for the same path, the redirect will take priority.
While most other entities use UUIDs as the primary key, landing pages are uniquely identified by their path. Because these paths can contain slashes, we append the path as a URL query parameter when making API calls (instead of the typical REST convention used elsewhere wherein the identifier is embedded in the URL structure itself).
All landing pages are defined as an Experiment. The conversion event for all landing page experiments is when an individual signs up and a new account is created.
Attributes:
Name | Type | Description |
---|---|---|
path | string | The path to identify the landing page. Must be unique for the application. |
name | string | Human-readable name associated with the landing page. |
experiment | object | Embedded Experiment object. The experiment will pull from the landing page's versions. |
referral_methodology | string | The Methodology used to merge referral parameters defined in the landing page vs supplied in the URL. |
referral | object | The default Referral object associated with the landing page. |
plan_group_id | string | The identifier of the plan group associated with the landing page. |
plan_id | string | The identifier of the plan associated with the landing page (must exist within the plan group). |
plan | object | The plan associated with the landing page. |
discount | object | The discount to apply to all signups generated by the landing page. |
enabled | boolean | Disabled landing pages will not be rendered. If the landing page is disabled for the requested path, the default landing page will be rendered. |
default | boolean | If the landing page is the default landing page for the application. Default landing pages cannot be disabled. |
html_header | object | The embedded HTML Header object for the landing page and all of its versions. |
versions | array | Array of Landing Page Versions available with this landing page. |
created_at | integer | Unix timestamp of when the landing page was created (in seconds since the Unix epoch). |
updated_at | integer | Unix timestamp of when the landing page was last updated (in seconds since the Unix epoch). |