Skip to main content
GET
/
api
/
v1
/
analytics
/
trends
Get trend analysis
curl --request GET \
  --url https://backyard.posthoot.com/api/v1/api/v1/analytics/trends
[
  {
    "clickCount": 123,
    "devices": {},
    "engagementRate": 123,
    "events": [
      {
        "browser": "<string>",
        "campaign": {
          "analytics": [
            {}
          ],
          "batchDelay": -9223372036854776000,
          "batchSize": 123,
          "createdAt": "<string>",
          "cronExpression": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": false,
          "list": {
            "contactImports": [
              {
                "contacts": [
                  {
                    "address": "<string>",
                    "city": "<string>",
                    "company": "<string>",
                    "country": "<string>",
                    "createdAt": "<string>",
                    "email": "<string>",
                    "facebook": "<string>",
                    "firstName": "<string>",
                    "id": "<string>",
                    "import": {},
                    "importId": "<string>",
                    "instagram": "<string>",
                    "isDeleted": true,
                    "lastName": "<string>",
                    "linkedin": "<string>",
                    "list": {},
                    "listId": "<string>",
                    "metadata": [
                      "<any>"
                    ],
                    "phone": "<string>",
                    "state": "<string>",
                    "status": "ACTIVE",
                    "tags": [
                      "<any>"
                    ],
                    "teamId": "<string>",
                    "twitter": "<string>",
                    "updatedAt": "<string>",
                    "zip": "<string>"
                  }
                ],
                "createdAt": "<string>",
                "fieldsMap": [
                  123
                ],
                "file": {
                  "createdAt": "<string>",
                  "id": "<string>",
                  "isDeleted": false,
                  "name": "<string>",
                  "path": "<string>",
                  "signedUrl": "<string>",
                  "size": 2,
                  "team": {
                    "apiKeys": [
                      "<any>"
                    ],
                    "automations": [
                      "<any>"
                    ],
                    "campaigns": [
                      "<any>"
                    ],
                    "createdAt": "<string>",
                    "domains": [
                      "<any>"
                    ],
                    "emailCategories": [
                      "<any>"
                    ],
                    "id": "<string>",
                    "invites": [
                      "<any>"
                    ],
                    "isDeleted": true,
                    "mailingLists": [
                      "<any>"
                    ],
                    "models": [
                      "<any>"
                    ],
                    "name": "<string>",
                    "settings": [
                      "<any>"
                    ],
                    "smtpConfigs": [
                      "<any>"
                    ],
                    "updatedAt": "<string>",
                    "users": [
                      "<any>"
                    ],
                    "webhooks": [
                      "<any>"
                    ]
                  },
                  "teamId": "<string>",
                  "type": "<string>",
                  "updatedAt": "<string>",
                  "user": {
                    "createdAt": "<string>",
                    "email": "<string>",
                    "files": [
                      "<any>"
                    ],
                    "firstName": "<string>",
                    "id": "<string>",
                    "invites": [
                      "<any>"
                    ],
                    "isDeleted": false,
                    "lastName": "<string>",
                    "permissions": [
                      "<any>"
                    ],
                    "profilePicture": {},
                    "profilePictureId": "<string>",
                    "provider": "<string>",
                    "providerData": [
                      "<any>"
                    ],
                    "providerId": "<string>",
                    "role": "SUPER_ADMIN",
                    "team": {},
                    "teamId": "<string>",
                    "updatedAt": "<string>"
                  },
                  "userId": "<string>"
                },
                "fileId": "<string>",
                "id": "<string>",
                "isDeleted": false,
                "list": {},
                "listId": "<string>",
                "status": "PENDING",
                "team": {
                  "apiKeys": [
                    "<any>"
                  ],
                  "automations": [
                    "<any>"
                  ],
                  "campaigns": [
                    "<any>"
                  ],
                  "createdAt": "<string>",
                  "domains": [
                    "<any>"
                  ],
                  "emailCategories": [
                    "<any>"
                  ],
                  "id": "<string>",
                  "invites": [
                    "<any>"
                  ],
                  "isDeleted": true,
                  "mailingLists": [
                    "<any>"
                  ],
                  "models": [
                    "<any>"
                  ],
                  "name": "<string>",
                  "settings": [
                    "<any>"
                  ],
                  "smtpConfigs": [
                    "<any>"
                  ],
                  "updatedAt": "<string>",
                  "users": [
                    "<any>"
                  ],
                  "webhooks": [
                    "<any>"
                  ]
                },
                "teamId": "<string>",
                "updatedAt": "<string>"
              }
            ],
            "contacts": [
              {
                "address": "<string>",
                "city": "<string>",
                "company": "<string>",
                "country": "<string>",
                "createdAt": "<string>",
                "email": "<string>",
                "facebook": "<string>",
                "firstName": "<string>",
                "id": "<string>",
                "import": {},
                "importId": "<string>",
                "instagram": "<string>",
                "isDeleted": true,
                "lastName": "<string>",
                "linkedin": "<string>",
                "list": {},
                "listId": "<string>",
                "metadata": [
                  123
                ],
                "phone": "<string>",
                "state": "<string>",
                "status": "ACTIVE",
                "tags": [
                  {}
                ],
                "teamId": "<string>",
                "twitter": "<string>",
                "updatedAt": "<string>",
                "zip": "<string>"
              }
            ],
            "createdAt": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": false,
            "name": "<string>",
            "team": {
              "apiKeys": [
                "<any>"
              ],
              "automations": [
                "<any>"
              ],
              "campaigns": [
                "<any>"
              ],
              "createdAt": "<string>",
              "domains": [
                "<any>"
              ],
              "emailCategories": [
                "<any>"
              ],
              "id": "<string>",
              "invites": [
                "<any>"
              ],
              "isDeleted": true,
              "mailingLists": [
                "<any>"
              ],
              "models": [
                "<any>"
              ],
              "name": "<string>",
              "settings": [
                "<any>"
              ],
              "smtpConfigs": [
                "<any>"
              ],
              "updatedAt": "<string>",
              "users": [
                "<any>"
              ],
              "webhooks": [
                "<any>"
              ]
            },
            "teamId": "<string>",
            "updatedAt": "<string>"
          },
          "listId": "<string>",
          "name": "<string>",
          "processed": 123,
          "recurringSchedule": "DAILY",
          "schedule": "ONE_TIME",
          "scheduledFor": "<string>",
          "sentEmails": [
            {
              "bcc": "<string>",
              "body": "<string>",
              "campaign": {},
              "campaignId": "<string>",
              "category": {},
              "categoryId": "<string>",
              "cc": "<string>",
              "contact": {
                "address": "<string>",
                "city": "<string>",
                "company": "<string>",
                "country": "<string>",
                "createdAt": "<string>",
                "email": "<string>",
                "facebook": "<string>",
                "firstName": "<string>",
                "id": "<string>",
                "import": {},
                "importId": "<string>",
                "instagram": "<string>",
                "isDeleted": true,
                "lastName": "<string>",
                "linkedin": "<string>",
                "list": {},
                "listId": "<string>",
                "metadata": [
                  123
                ],
                "phone": "<string>",
                "state": "<string>",
                "status": "ACTIVE",
                "tags": [
                  {}
                ],
                "teamId": "<string>",
                "twitter": "<string>",
                "updatedAt": "<string>",
                "zip": "<string>"
              },
              "contactId": "<string>",
              "createdAt": "<string>",
              "data": [
                123
              ],
              "error": "<string>",
              "from": "<string>",
              "id": "<string>",
              "isDeleted": true,
              "replyTo": "<string>",
              "sendAt": "<string>",
              "sentAt": "<string>",
              "smtpConfig": {
                "createdAt": "<string>",
                "fromEmail": "<string>",
                "host": "<string>",
                "id": "<string>",
                "isActive": true,
                "isDefault": true,
                "isDeleted": true,
                "maxSendRate": 2,
                "password": "<string>",
                "port": 32768,
                "provider": "CUSTOM",
                "requiresAuth": true,
                "supportsTls": true,
                "teamId": "<string>",
                "updatedAt": "<string>",
                "username": "<string>"
              },
              "smtpConfigId": "<string>",
              "status": "SENT",
              "subject": "<string>",
              "team": {},
              "teamId": "<string>",
              "template": {
                "category": {},
                "categoryId": "<string>",
                "createdAt": "<string>",
                "designJson": "<string>",
                "emails": [
                  {}
                ],
                "htmlFile": {},
                "htmlFileId": "<string>",
                "id": "<string>",
                "isDeleted": true,
                "name": "<string>",
                "subject": "<string>",
                "team": {},
                "teamId": "<string>",
                "updatedAt": "<string>",
                "variables": [
                  "<string>"
                ]
              },
              "templateId": "<string>",
              "test": true,
              "to": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "smtpConfig": {
            "createdAt": "<string>",
            "fromEmail": "<string>",
            "host": "<string>",
            "id": "<string>",
            "isActive": true,
            "isDefault": true,
            "isDeleted": true,
            "maxSendRate": 2,
            "password": "<string>",
            "port": 32768,
            "provider": "CUSTOM",
            "requiresAuth": true,
            "supportsTls": true,
            "teamId": "<string>",
            "updatedAt": "<string>",
            "username": "<string>"
          },
          "smtpConfigId": "<string>",
          "status": "DRAFT",
          "team": {
            "apiKeys": [
              "<any>"
            ],
            "automations": [
              "<any>"
            ],
            "campaigns": [
              "<any>"
            ],
            "createdAt": "<string>",
            "domains": [
              "<any>"
            ],
            "emailCategories": [
              "<any>"
            ],
            "id": "<string>",
            "invites": [
              "<any>"
            ],
            "isDeleted": true,
            "mailingLists": [
              "<any>"
            ],
            "models": [
              "<any>"
            ],
            "name": "<string>",
            "settings": [
              "<any>"
            ],
            "smtpConfigs": [
              "<any>"
            ],
            "updatedAt": "<string>",
            "users": [
              "<any>"
            ],
            "webhooks": [
              "<any>"
            ]
          },
          "teamId": "<string>",
          "template": {
            "category": {},
            "categoryId": "<string>",
            "createdAt": "<string>",
            "designJson": "<string>",
            "emails": [
              {}
            ],
            "htmlFile": {},
            "htmlFileId": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "subject": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>",
            "variables": [
              "<string>"
            ]
          },
          "templateId": "<string>",
          "timezone": "<string>",
          "updatedAt": "<string>"
        },
        "campaignId": "<string>",
        "city": "<string>",
        "contact": {
          "address": "<string>",
          "city": "<string>",
          "company": "<string>",
          "country": "<string>",
          "createdAt": "<string>",
          "email": "<string>",
          "facebook": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "import": {},
          "importId": "<string>",
          "instagram": "<string>",
          "isDeleted": true,
          "lastName": "<string>",
          "linkedin": "<string>",
          "list": {},
          "listId": "<string>",
          "metadata": [
            123
          ],
          "phone": "<string>",
          "state": "<string>",
          "status": "ACTIVE",
          "tags": [
            {}
          ],
          "teamId": "<string>",
          "twitter": "<string>",
          "updatedAt": "<string>",
          "zip": "<string>"
        },
        "contactId": "<string>",
        "country": "<string>",
        "createdAt": "<string>",
        "deviceType": "desktop",
        "email": {
          "bcc": "<string>",
          "body": "<string>",
          "campaign": {},
          "campaignId": "<string>",
          "category": {},
          "categoryId": "<string>",
          "cc": "<string>",
          "contact": {
            "address": "<string>",
            "city": "<string>",
            "company": "<string>",
            "country": "<string>",
            "createdAt": "<string>",
            "email": "<string>",
            "facebook": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "import": {},
            "importId": "<string>",
            "instagram": "<string>",
            "isDeleted": true,
            "lastName": "<string>",
            "linkedin": "<string>",
            "list": {},
            "listId": "<string>",
            "metadata": [
              123
            ],
            "phone": "<string>",
            "state": "<string>",
            "status": "ACTIVE",
            "tags": [
              {}
            ],
            "teamId": "<string>",
            "twitter": "<string>",
            "updatedAt": "<string>",
            "zip": "<string>"
          },
          "contactId": "<string>",
          "createdAt": "<string>",
          "data": [
            123
          ],
          "error": "<string>",
          "from": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "replyTo": "<string>",
          "sendAt": "<string>",
          "sentAt": "<string>",
          "smtpConfig": {
            "createdAt": "<string>",
            "fromEmail": "<string>",
            "host": "<string>",
            "id": "<string>",
            "isActive": true,
            "isDefault": true,
            "isDeleted": true,
            "maxSendRate": 2,
            "password": "<string>",
            "port": 32768,
            "provider": "CUSTOM",
            "requiresAuth": true,
            "supportsTls": true,
            "teamId": "<string>",
            "updatedAt": "<string>",
            "username": "<string>"
          },
          "smtpConfigId": "<string>",
          "status": "SENT",
          "subject": "<string>",
          "team": {},
          "teamId": "<string>",
          "template": {
            "category": {},
            "categoryId": "<string>",
            "createdAt": "<string>",
            "designJson": "<string>",
            "emails": [
              {}
            ],
            "htmlFile": {},
            "htmlFileId": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "subject": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>",
            "variables": [
              "<string>"
            ]
          },
          "templateId": "<string>",
          "test": true,
          "to": "<string>",
          "updatedAt": "<string>"
        },
        "emailId": "<string>",
        "event": "click",
        "id": "<string>",
        "ipAddress": "<string>",
        "isDeleted": false,
        "metadata": [
          123
        ],
        "os": "<string>",
        "region": "<string>",
        "timestamp": "<string>",
        "updatedAt": "<string>",
        "url": "<string>",
        "userAgent": "<string>"
      }
    ],
    "growth": 123,
    "locations": {},
    "openCount": 123,
    "period": "<string>"
  }
]

Query Parameters

teamId
string
required

Team ID

Response

Trend analysis

clickCount
integer
devices
object
engagementRate
number
events
object[]
growth
number
locations
object
openCount
integer
period
string