Restful API with JSON recovery

Prerequisites

First, we will present the steps that will allow you to obtain a secured access to our API. This API will allow you to retrieve the leads that have been registered on Appvizer from your different campaigns.

The steps in the process of obtaining access are as follows:

• To begin with, you need to provide an email address to our services. We recommend choosing a service email address or at least one that will not change in the event of the departure of an employee.
• Then, our services will send you an invitation email containing a temporary password. This invitation will direct you to the login page on the interface where, after logging in, you can modify your password by going to the "profile" page. This step is not mandatory but is strongly recommended.

API calls

Endpoint description

Request method: POST

URL: https://rocket-lead.netlify.app/.netlify/functions/getAll

‍Body:

• email : String (mandatory)
• password : String (mandatory)
• filter : (optional)
  • startDate : Date (format YYYY-MM-DD) (optional)
  • endDate : Date (format YYYY-MM-DD) (optional)
• order: (optional)
  • column : Enum("lastname", "email", "date") (mandatory if order is used)
  • ascending: Boolean (mandatory if order is used)

Body examples

In this part, the body of the HTTP requests will be sent in JSON format. This following section details examples of these bodies.

Get all your leads

{
  "email": "<your_registration_email>",
  "password": "<your_password>"
}

Get all your leads on a specific period

//Get all your leads from 1st of march to 30st april 2022
{
  "email": "<your_registration_email>",
  "password": "<your_password>",
  "filter": {
    "startDate": "2022-03-01",
    "endDate": "2022-04-30"
  }
}

//Get all your leads from the 1st of march 2022
{
  "email": "<your_registration_email>",
  "password": "<your_password>",
  "filter": {
    "startDate": "2022-03-01"
  }
}

//Get all your leads until 30st of april 2022
{
  "email": "<your_registration_email>",
  "password": "<your_password>",
  "filter": {
    "endDate": "2022-04-30"
  }
}

Get all your leads by a specific column

Your can order your leads using the columns "lastname" or "email" from A to Z (ascending: true) and from Z to A (ascending: false), then by date of creation from newest to oldest (ascending: true) and from oldest to newest (ascending: false).

//Get all your leads from 1rst of march to 30st of april 2022 order by date from oldest to newest!
{
  "email": "<your_registration_email>",
  "password": "<your_password>",
  "filter": {
    "startDate": "2022-03-01",
    "endDate": "2022-04-30"
  },
  "order": {
    "column": "date",
    "ascending": false
  }
}

//Get all your leads order by email from A to Z
{
  "email": "<your_registration_email>",
  "password": "<your_password>",
  "order": {
    "column": "email",
    "ascending": true
  }
}