Campaigns

In the campaigns section, you'll be able to check the information of all notifications that have been sent in bulk.

Get Campaigns

Params

Field	Type	Description	Required
page	number	Page number. Default 1	N
limit	number	Number of records. Default 10, maximum 50.	N
botId	string	Bot ID	Y
startAt	date	Start date	Y
endAt	date	End date	Y
elementName	string	Template name	N
status	string	Campaign status. Allowed values: [COMPLETED, PENDING, IN_PROGRESS, SCHEDULED]	N

cURL

curl --request GET \
  --url 'https://api.jelou.ai/v1/campaigns?page=1&limit=20&botId=BOT_ID&startAt=START_AT&endAt=END_AT' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}'

Responses

200

The total number of records and pagination information are returned in the 'pagination' object, while the 'results' array describes the campaigns that match the search parameters

{
  "pagination": {
    "limit": 10,
    "page": 1,
    "total": 1,
    "offset": 0,
    "totalPages": 1
  },
  "_metadata": {},
  "results": [
    {
      "_id": "CAMPAIGN_ID",
      "name": "CAMPAIGN_NAME",
      "fileName": "FILE_NAME",
      "status": "COMPLETED",
      "botId": "BOT_ID",
      "companyId": "COMPANY_ID",
      "bot": {
        "id": "BOT_ID",
        "name": "BOT_NAME"
      },
      "company": {
        "id": "COMPANY_ID",
        "name": "COMPANY_NAME"
      },
      "rowCount": "TOTAL_ROWS",
      "storageUrl": "FILE_URL",
      "metadata": {},
      "sendBy": {
        "id": "COMPANY_ID",
        "names": "USER_NAME",
        "email": "USER_EMAIL",
        "companyId": "COMPANY_ID"
      },
      "scheduledAt": "SCHEDULED_AT",
      "createdAt": "CREATED_AT",
      "updatedAt": "UPDATED_AT"
    }
  ]
}

422

Error that occurs when an entered parameter is not of the correct type or the entered value is not allowed.

{
  "message": [
    "Los valores ingresados no son correctos."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0422",
    "key": "VALIDATOR_ERROR",
    "description": "Error to be thrown when cannot process request because of incoming values",
    "developerMessages": {
      "es": "Los valores del request no son correctos para ser procesados.",
      "en": "The request values are not correct for processing."
    },
    "clientMessages": {
      "es": "Los valores ingresados no son correctos.",
      "en": "The values entered are not correct."
    }
  },
  "validationError": {
    "startAt": [
      "the startAt field must be a valid Date"
    ]
  }
}

500

Server Error

{
  "message": [
    "We are having trouble processing your request. Please try again later."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}