API Restful avec récupération au format JSON

Appels API

Descriptif de l'endpoint

Request method : POST

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

‍Body :

• email : String (obligatoire)
• password : String (obligatoire)
• filter : (facultatif)
  • startDate : Date (format YYYY-MM-DD) (facultatif)
  • endDate : Date (format YYYY-MM-DD) (facultatif)
• order: (facultatif)
  • column : Enum("lastname", "email", "date") (obligatoire si order)
  • ascending: Boolean (obligatoire si order)

Exemples de body

Dans cette partie, le JSON correspondra au body au format JSON à fournir dans votre requête.

Récupération de tous vos leads

{
  "email": "<votre_mail_d'inscription>",
  "password": "<votre_mot_de_passe>"
}

Récupération de vos leads sur une période donnée

//Récupération des leads sur la période du 1er mars au 30 avril 2022
{
  "email": "<votre_mail_d'inscription>",
  "password": "<votre_mot_de_passe>",
  "filter": {
    "startDate": "2022-03-01",
    "endDate": "2022-04-30"
  }
}

//Récupération des leads à partir du 1er mars 2022
{
  "email": "<votre_mail_d'inscription>",
  "password": "<votre_mot_de_passe>",
  "filter": {
    "startDate": "2022-03-01"
  }
}

//Récupération des leads jusqu'au 30 avril 2022
{
  "email": "<votre_mail_d'inscription>",
  "password": "<votre_mot_de_passe>",
  "filter": {
    "endDate": "2022-04-30"
  }
}

Récupération des leads triés en fonction d'une colonne

Vous pouvez trier les leads via les colonnes "lastname" ou "email" de A à Z (ascending: true) et de Z à A (ascending: false), puis par date de création de la plus récente à la plus ancienne (ascending: true) et de la plus ancienne à la plus récente (ascending: false).

//Récupération des leads sur la période du 1er mars au 30 avril 2022 triés par dates de la plus ancienne à la plus récente !
{
  "email": "<votre_mail_d'inscription>",
  "password": "<votre_mot_de_passe>",
  "filter": {
    "startDate": "2022-03-01",
    "endDate": "2022-04-30"
  },
  "order": {
    "column": "date",
    "ascending": false
  }
}

//Récupération de tous les leads triés par email de A à Z
{
  "email": "<votre_mail_d'inscription>",
  "password": "<votre_mot_de_passe>",
  "order": {
    "column": "email",
    "ascending": true
  }
}