Landing Pages

Landing Page reports

Available methods

    • No Summary

      GET /reporting/landing-pages

      Get reports of Landing Pages

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.

      Response body parameters

      landing_pages Type: Array Title: No Title Read only: false No Description
      Show properties
      id Type: String Title: Landing Page ID Read only: false A string that uniquely identifies this landing page.
      name Type: String Title: Name Read only: false The name of this landing page the user will see.
      title Type: String Title: Title Read only: false The name of the landing page the user’s customers will see.
      url Type: String Title: Url Read only: false The landing page url.
      published_at Type: String Title: Published At Read only: false The time this landing page was published.
      unpublished_at Type: String Title: Unpublished At Read only: false The time this landing page was unpublished.
      status Type: String Title: Status Read only: false The status of the landing page.
      list_id Type: String Title: List Id Read only: false The list id connected to this landing page.
      visits Type: Integer Title: Visits Read only: false The number of visits to this landing pages.
      unique_visits Type: Integer Title: Unique Visits Read only: false The number of unique visits to this landing pages.
      subscribes Type: Integer Title: Subscribes Read only: false The number of subscribes to this landing pages.
      clicks Type: Integer Title: Clicks Read only: false The number of clicks to this landing pages.
      conversion_rate Type: Integer Title: Conversion rate Read only: false The percentage of people who visited your landing page and were added to your list.
      timeseries Type: Object Title: No Title Read only: false No Description
      Show properties
      daily_stats Type: Object Title: Daily clicks and visits data Read only: false The clicks and visits data from the last seven days.
      Show properties
      clicks Type: Array Title: Clicks Read only: false No Description
      visits Type: Array Title: Visits Read only: false No Description
      unique_visits Type: Array Title: Unique Visits Read only: false No Description
      weekly_stats Type: Object Title: Weekly clicks and visits data Read only: false The clicks and visits data from the last five weeks.
      Show properties
      clicks Type: Array Title: Clicks Read only: false The total number of clicks in a week.
      visits Type: Array Title: Visits Read only: false The total number of visits in a week.
      unique_visits Type: Array Title: Unique Visits Read only: false No Description
      ecommerce Type: Object Title: No Title Read only: false No Description
      Show properties
      total_revenue Type: Number Title: Total Revenue Read only: false The total revenue of this landing page.
      currency_code Type: String Title: Currency code Read only: false The user’s currency code.
      total_orders Type: Integer Title: Total Orders Read only: false The total number of orders associated with this landing page.
      average_order_revenue Type: Number Title: Average Order Revenue Read only: false The average order revenue of this landing page.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      No Summary

      GET /reporting/landing-pages/{outreach_id}

      Get report of a landing page

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: String Title: Landing Page ID Read only: false A string that uniquely identifies this landing page.
      name Type: String Title: Name Read only: false The name of this landing page the user will see.
      title Type: String Title: Title Read only: false The name of the landing page the user’s customers will see.
      url Type: String Title: Url Read only: false The landing page url.
      published_at Type: String Title: Published At Read only: false The time this landing page was published.
      unpublished_at Type: String Title: Unpublished At Read only: false The time this landing page was unpublished.
      status Type: String Title: Status Read only: false The status of the landing page.
      list_id Type: String Title: List Id Read only: false The list id connected to this landing page.
      visits Type: Integer Title: Visits Read only: false The number of visits to this landing pages.
      unique_visits Type: Integer Title: Unique Visits Read only: false The number of unique visits to this landing pages.
      subscribes Type: Integer Title: Subscribes Read only: false The number of subscribes to this landing pages.
      clicks Type: Integer Title: Clicks Read only: false The number of clicks to this landing pages.
      conversion_rate Type: Integer Title: Conversion rate Read only: false The percentage of people who visited your landing page and were added to your list.
      timeseries Type: Object Title: No Title Read only: false No Description
      Show properties
      daily_stats Type: Object Title: Daily clicks and visits data Read only: false The clicks and visits data from the last seven days.
      Show properties
      clicks Type: Array Title: Clicks Read only: false No Description
      visits Type: Array Title: Visits Read only: false No Description
      unique_visits Type: Array Title: Unique Visits Read only: false No Description
      weekly_stats Type: Object Title: Weekly clicks and visits data Read only: false The clicks and visits data from the last five weeks.
      Show properties
      clicks Type: Array Title: Clicks Read only: false The total number of clicks in a week.
      visits Type: Array Title: Visits Read only: false The total number of visits in a week.
      unique_visits Type: Array Title: Unique Visits Read only: false No Description
      ecommerce Type: Object Title: No Title Read only: false No Description
      Show properties
      total_revenue Type: Number Title: Total Revenue Read only: false The total revenue of this landing page.
      currency_code Type: String Title: Currency code Read only: false The user’s currency code.
      total_orders Type: Integer Title: Total Orders Read only: false The total number of orders associated with this landing page.
      average_order_revenue Type: Number Title: Average Order Revenue Read only: false The average order revenue of this landing page.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.