API Documentation

EcardWidget.com's API Docs

Tim Badolato

Last Update há 2 meses

We are in early development of our API so if you have any requests please reach out.


Below are the API endpoints that are currently available.​

Stats API Endpoint 


Request:

GET 'https://app.ecardwidget.com/api/stats/list?perPage=1&page=1&includeEmails=true'

header 'Authorization: Bearer YOUR_API_KEY'

Query parmeters:

type [optional] = email | facebook | twitter

page [optional] = number

perPage [optional] = number (MAX 200)

widgetid [optional] = number

ecardid [optional] = number

includeEmails [optional] = boolean

Response:

{

  "meta": {

     "pagination": {

       "perPage": 1,

       "totalPages": 27,

       "currentPage": 1,

       "totalRecords": 263

     },

     "totalsByType": {

     "twitter": 554,

     "facebook": 859,

     "email": 921

  }

  },

  "data": [

    {

       "createdAt": "April, 12 2021 15:31:03 +0000",

       "recipient_email": "[email protected]",

       "sender_email": "[email protected]",

       "widgetid": 1915,

       "ecardid": 6205,

       "id": 85473,

       "type": "email",

       "sender_name": "Tim",

       "recipient_name": "Bob"

    }

  ],

  "message": "",

  "success": true

}

Was this article helpful?

0 out of 0 liked this article