Instapage

App · 19 actions

Manage Instapage landing pages, groups, leads, lead notifications and page statistics.

Actions

ActionWhat it does
Add lead notification recipientsEmail more people about a page's new leads.
Copy pageMake an unpublished copy of a landing page, in the same workspace or another one.
Create groupCreate a page group (folder) in a workspace.
Delete form submissionsPermanently delete up to 100 form submissions.
Delete groupDelete an empty page group (folder).
Delete pageDelete a landing page with its personalized versions.
Get lead notification settingsGet who is emailed about a page's new leads, and how the email looks.
Get pageGet a landing page's title, address, publishing status and group.
Get page statisticsGet visits, conversions and leads for up to 100 pages over a period.
List A/B testsList the A/B tests (experiments) in a workspace with their pages and status.
List form submissionsList the leads submitted through the forms on chosen pages, 100 at a time.
List groupsList the page groups (folders) in a workspace, with the pages in each.
List pagesList the landing pages in a workspace, 100 at a time.
List team membersList the people in a workspace with their role and invitation status.
List workspacesList the Instapage workspaces this connection can reach.
Move page to groupPut a landing page in a group (folder), or take it out of its group.
Publish pagePut a landing page live at an address.
Remove lead notification recipientsStop emailing these people about a page's new leads.
Unpublish pageTake a published landing page offline.

Add lead notification recipients

Email more people about a page's new leads. Everyone already on the list stays on it.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.
Email addressesrecipientslistRequired
Email addresses to notify about new leads, up to 15.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Copy page

Make an unpublished copy of a landing page, in the same workspace or another one. Trial accounts and viewers can't copy pages, and AMP pages can't be copied.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.
TitletitletextRequired
The new page's title, up to 255 characters.
Copy to workspacetarget_workspace_idtext
The workspace to put the copy in. Leave blank to use the same workspace.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": {
      "pageId": 1,
      "title": "example",
      "workspaceId": 1
    }
  }
}

Create group

Create a page group (folder) in a workspace.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
NamenametextRequired
The group's name.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": {
      "id": 1,
      "name": "example",
      "pages": [
        1
      ]
    },
    "meta": {
      "workspaceId": 1
    }
  }
}

Delete form submissions

Permanently delete up to 100 form submissions. This can't be undone.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Submission IDssubmission_idslistRequired
The submissions to delete, from List form submissions.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Delete group

Delete an empty page group (folder). Move its pages out first.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Groupgroup_idtextRequired
The page group (folder).

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Delete page

Delete a landing page with its personalized versions. Stop any running A/B test on the page first.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Get lead notification settings

Get who is emailed about a page's new leads, and how the email looks.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": {
      "recipients": [
        {
          "email": "example",
          "status": "example"
        }
      ],
      "setup": {
        "customHtml": "example",
        "fromName": "example",
        "isBranded": true,
        "logo": "example",
        "replyTo": "example",
        "subject": "example"
      }
    }
  }
}

Get page

Get a landing page's title, address, publishing status and group.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": {
      "createdAt": 1,
      "groupId": 1,
      "id": 1,
      "isDeleted": true,
      "isScheduled": true,
      "pageType": "example",
      "publishMethod": "example",
      "publishStatus": "example",
      "publishedAt": 1,
      "title": "example",
      "totalPersonalizedExperienceCount": 1,
      "updatedAt": 1,
      "url": "example"
    }
  }
}

Get page statistics

Get visits, conversions and leads for up to 100 pages over a period. Times are in UTC.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagespage_idslistRequired
The landing pages to include, up to 100.
Fromstartdate and time
Start of the period. Leave blank to count from the beginning.
Toenddate and time
End of the period. Leave blank to count up to now.
Totals perintervaltext
Add up the numbers by hour, day, month or year. Monthly unless you choose.One of: hourly, daily, monthly, yearly.
Break down bybreakdowntext
Give separate numbers for each page, each A/B test variation, or both.One of: page, variation, page_and_variation (Page and variation).
Devicedevicetext
Count visits from any device, or only desktop or only mobile.One of: any, desktop, mobile.
Traffictraffictext
Count all traffic, or only organic or only paid visits.One of: blended, organic, paid.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": [
      {
        "conversion": 1,
        "key": {
          "date": 1,
          "pageId": 1,
          "variationId": 1
        },
        "leads": 1,
        "visit": 1
      }
    ]
  }
}

List A/B tests

List the A/B tests (experiments) in a workspace with their pages and status.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Statusstatuseslist
Only return A/B tests with these statuses.One or more of: draft, running, ended, archived.
Results pagepagenumber
Which page of results to return, 100 at a time. Leave blank for the first.At least 1.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": [
      {
        "createdAt": 1,
        "createdBy": 1,
        "endedAt": 1,
        "experimentId": 1,
        "experimentName": "example",
        "experimentStatus": "example",
        "experimentType": "example",
        "pageId": 1,
        "publishedPageUrl": "example",
        "startedAt": 1
      }
    ],
    "meta": {
      "pagination": {
        "currentPage": 1,
        "nextPage": 1,
        "perPage": 1,
        "previousPage": 1,
        "totalItemsCount": 1,
        "totalPagesCount": 1
      }
    }
  }
}

List form submissions

List the leads submitted through the forms on chosen pages, 100 at a time.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagespage_idslistRequired
The landing pages to include, up to 100.
Fromstartdate and time
Only return submissions made at or after this time.
Toenddate and time
Only return submissions made before this time.
Next page tokennext_page_tokentext
To get the next 100, use the next page token from the previous result.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": {
      "submissions": [
        {
          "createdAt": 1,
          "fields": {},
          "id": "example",
          "pageId": 1,
          "variationCustomName": "example",
          "variationName": "example"
        }
      ]
    },
    "meta": {
      "limit": 1,
      "nextPageToken": "example"
    }
  }
}

List groups

List the page groups (folders) in a workspace, with the pages in each.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Results pagepagenumber
Which page of results to return, 100 at a time. Leave blank for the first.At least 1.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": [
      {
        "id": 1,
        "name": "example",
        "pages": [
          1
        ]
      }
    ],
    "meta": {
      "pagination": {
        "currentPage": 1,
        "nextPage": 1,
        "perPage": 1,
        "previousPage": 1,
        "totalItemsCount": 1,
        "totalPagesCount": 1
      },
      "workspaceId": 1
    }
  }
}

List pages

List the landing pages in a workspace, 100 at a time.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Statuspublish_statustext
Only return pages with this publishing status.One of: published, unpublished, published_with_unpublished_changes (Published with unpublished changes).
Groupgroup_idnumber
Only return pages in this group (folder).
Created aftercreated_afterdate and time
Only return pages created after this time.
Changed afterupdated_afterdate and time
Only return pages changed after this time.
Published afterpublished_afterdate and time
Only return pages published after this time.
Deleted pagesdeletedtrue/false
Return only deleted pages instead of current ones.
Results pagepagenumber
Which page of results to return, 100 at a time. Leave blank for the first.At least 1.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": [
      {
        "createdAt": 1,
        "groupId": 1,
        "id": 1,
        "isDeleted": true,
        "isScheduled": true,
        "pageType": "example",
        "publishMethod": "example",
        "publishStatus": "example",
        "publishedAt": 1,
        "title": "example",
        "totalPersonalizedExperienceCount": 1,
        "updatedAt": 1,
        "url": "example"
      }
    ],
    "meta": {
      "pagination": {
        "currentPage": 1,
        "nextPage": 1,
        "perPage": 1,
        "previousPage": 1,
        "totalItemsCount": 1,
        "totalPagesCount": 1
      }
    }
  }
}

List team members

List the people in a workspace with their role and invitation status.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": [
      {
        "accessLevel": "example",
        "email": "example",
        "fullName": "example",
        "inheritOwnerContextInPublicApi": true,
        "invitationStatus": "example",
        "invitedAt": 1,
        "lastActivityInWorkspaceAt": 1,
        "lastLoginAt": 1,
        "userId": 1
      }
    ]
  }
}

List workspaces

List the Instapage workspaces this connection can reach.

Inputs

Workspace namenametext
Only return the workspace with this name. Upper and lower case don't matter.
Results pagepagenumber
Which page of results to return, 100 at a time. Leave blank for the first.At least 1.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {
    "data": [
      {
        "accessLevel": "example",
        "createdAt": 1,
        "ownerId": 1,
        "workspaceId": 1,
        "workspaceName": "example"
      }
    ],
    "meta": {
      "pagination": {
        "currentPage": 1,
        "nextPage": 1,
        "perPage": 1,
        "previousPage": 1,
        "totalItemsCount": 1,
        "totalPagesCount": 1
      }
    }
  }
}

Move page to group

Put a landing page in a group (folder), or take it out of its group.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.
Groupgroup_idnumber
The group to move the page into. Leave blank to take the page out of its group.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Publish page

Put a landing page live at an address. Publishing this way clears any publishing schedule set for the page.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.
Publish topublication_methodtextRequired
Where the page goes live: your own domain, a free Instapage address ending in .pagedemo.co, or a connected WordPress or Drupal site.One of: custom_domain (Custom domain), free_address (Free address), wordpress, drupal.
Addresstarget_urltext
The page's address, such as offer.example.com/spring or spring-offer.pagedemo.co. Leave blank for WordPress or Drupal.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Remove lead notification recipients

Stop emailing these people about a page's new leads.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.
Email addressesrecipientslistRequired
Email addresses to notify about new leads, up to 15.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

Unpublish page

Take a published landing page offline. This also clears any publishing schedule set for the page.

Inputs

Workspaceworkspace_idtextRequired
The workspace the pages belong to.
Pagepage_idtextRequired
The landing page.

Outputs

dataobject
The response from Instapage.
Example output
{
  "data": {}
}

On this page