Analytics

Below is a reference to the Endgrate types supported for analytics integrations, and their corresponding default schemas.

analytics-lead

Schema:

{
  "addresses": {
    "items": {
      "properties": {
        "address_type": {
          "enum": [
            "PRIMARY",
            "SECONDARY",
            "OFFICE",
            "SHIPPING",
            "BILLING",
            "OTHER"
          ],
          "title": "Address Type",
          "type": "string"
        },
        "city": {
          "title": "City",
          "type": "string"
        },
        "country": {
          "title": "Country",
          "type": "string"
        },
        "postal_code": {
          "title": "Postal Code",
          "type": "string"
        },
        "state": {
          "title": "State",
          "type": "string"
        },
        "street_1": {
          "title": "Street 1",
          "type": "string"
        },
        "street_2": {
          "title": "Street 2",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "company": {
    "title": "Company",
    "type": "string"
  },
  "email_addresses": {
    "items": {
      "properties": {
        "email_address": {
          "title": "Email Address",
          "type": "string"
        },
        "email_address_type": {
          "enum": [
            "WORK",
            "PERSONAL",
            "OTHER"
          ],
          "title": "Email Address Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "first_name": {
    "title": "First Name",
    "type": "string"
  },
  "last_name": {
    "title": "Last Name",
    "type": "string"
  },
  "lead_source": {
    "title": "Lead Source",
    "type": "string"
  },
  "phone_numbers": {
    "items": {
      "properties": {
        "phone_number": {
          "title": "Phone Number",
          "type": "string"
        },
        "phone_number_type": {
          "enum": [
            "HOME",
            "WORK",
            "PERSONAL",
            "MOBILE",
            "OTHER"
          ],
          "title": "Phone Number Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "title": {
    "title": "Title",
    "type": "string"
  }
}

Example Object:

{
  "addresses": [
    {
      "address_type": "PRIMARY",
      "city": "New York",
      "country": "United States",
      "postal_code": "10001",
      "state": "NY",
      "street_1": "20 W 34th St",
      "street_2": "Apt 101"
    }
  ],
  "company": "Endgrate",
  "email_addresses": [
    {
      "email_address": "[email protected]",
      "email_address_type": "WORK"
    }
  ],
  "first_name": "John",
  "last_name": "Doe",
  "lead_source": "Social Media",
  "phone_number": [
    {
      "phone_number": "+1 631-555-1234",
      "phone_number_type": "WORK"
    }
  ],
  "title": "title"
}

analytics-note

Schema:

{
  "content": {
    "title": "Content",
    "type": "string"
  },
  "subject": {
    "title": "Title",
    "type": "string"
  }
}

Example Object:

{
  "content": "Example note.",
  "subject": "Example"
}

analytics-page_analytics

Schema:

{
  "active_users": {
    "title": "Active Users",
    "type": "number"
  },
  "avg_duration": {
    "title": "Average Session Duration",
    "type": "number"
  },
  "engaged_sessions": {
    "title": "Engaged Sessions",
    "type": "number"
  },
  "page_views": {
    "title": "Page Views",
    "type": "number"
  },
  "path": {
    "title": "Path",
    "type": "string"
  }
}

Example Object:

{
  "active_users": 1000,
  "avg_duration": 50,
  "engaged_sessions": 50,
  "page_views": 1000,
  "path": "Path"
}

analytics-page_views

Schema:

{
  "number_of_accounts": {
    "title": "Number of Accounts",
    "type": "number"
  },
  "number_of_visitors": {
    "title": "Number of Visitors",
    "type": "number"
  },
  "page_views": {
    "title": "Page Views",
    "type": "number"
  },
  "path": {
    "title": "Path",
    "type": "string"
  },
  "week": {
    "format": "date",
    "title": "Week",
    "type": "string"
  },
  "week_number": {
    "title": "Week Number",
    "type": "number"
  }
}

Example Object:

{
  "number_of_accounts": 1000,
  "number_of_visitors": 50,
  "page_views": 1000,
  "path": "/test",
  "week": "2024-01-0",
  "week_number": 15
}

analytics-user

Schema:

{
  "analytics_user": {
    "active": {
      "title": "Account Activity Status",
      "type": "boolean"
    },
    "last_used": {
      "format": "date-time",
      "title": "Date of Last Use",
      "type": "string"
    },
    "time_of_creation": {
      "format": "date-time",
      "title": "Time of Account Creation",
      "type": "string"
    },
    "username": {
      "title": "Username",
      "type": "string"
    }
  }
}

Example Object:

{
  "active": "true",
  "last_used": "2024-01-02 00:00:00",
  "time_of_creation": "2022-01-02 00:00:00",
  "username": "endgrate"
}

analytics-user_count

Schema:

{
  "active_count": {
    "title": "Active Users Count",
    "type": "number"
  },
  "inactive_count": {
    "title": "Inactive Users Count",
    "type": "number"
  }
}

Example Object:

{
  "active_count": 1000,
  "inactive_count": 5000
}