---
# System prepended metadata

title: User Onboarding Dashboard Documentation

---

# User Onboarding Dashboard Documentation
All the user onboarding dashboard APIs are in the context of a user. The APIs will identify the user using the `api_key` provided in the API calls.

**Dashboard Tab**
* Create API

```
{
    name: "dummy name",
    sequence: 1
}
```

* Delete API
    - dashboard_tab_id in the URL params


* Listing API
    - Array of objects order by the sequence number

```
[
    {
        name: "dummy name",
        sequence: 1
    },
    {
        name: "dummy name 1",
        sequence: 2
    }
]
```

* Update API (Name and Sequence)

```
{
    name: "dummy name",
    sequence: 1
}
```

* Single Dashboard Tab Details API (dashboard_tab_id URL parameter required)

```
{
    name: "dummy name",
    sequence: 1,
    use_case_widgets: [
        {
            id: 1,
            dashboard_tab_id: 1,
            use_case: {
                {
                    id: 1,
                    identifier: "use case id",
                    title: "use case title",
                    name: "use case name",
                    description: "use case description"
                }
            },
            sequence: 1
        }
    ]
}
```


**UseCaseWidget APIs (For a dashboard tab)**
All the use_case_widgets will be inside a dashboard tab context

* Listing API

```
[
    {
        id: 1,
        dashboard_tab_id: 1,
        use_case: {
            {
                id: 1,
                identifier: "use case id",
                title: "use case title",
                name: "use case name",
                description: "use case description"
            }
        },
        sequence: 1
    },
    {
        id: 1,
        dashboard_tab_id: 1,
        use_case: {
            {
                id: 1,
                identifier: "use case id",
                title: "use case title",
                name: "use case name",
                description: "use case description"
            }
        },
        sequence: 1
    }
]
```

* Delete API
    - use_case_widget_id in the URL params


* Add API

```
{
    dashboard_tab_id: 1,
    use_case_id: 1,
    sequence: 1
}
```

* Update API (Use-Case, Sequence)

```
{
    dashboard_tab_id: 1,
    use_case_id: 1,
    sequence: 1
}
```

**UseCases**

* Listing API
    - This API will not have the usecases which are already added to widgets for this user.

```
[
    {
        id: 1,
        identifier: "use case id",
        title: "use case title",
        name: "use case name",
        description: "use case description"
    },
    {
        id: 1,
        identifier: "use case id",
        title: "use case title",
        name: "use case name",
        description: "use case description"
    }
]
```

* Details API

```
{
    id: 1,
    identifier: "use case id",
    title: "use case title",
    name: "use case name",
    description: "use case description"
}
```

##TODO - **Permanent Widgets**

- Use case widget configured API

**URL:**

**PATCH /api/v0/dashboard_tabs/:dashboard_tab_id/use_case_widgets/:id**

```
{
    configured: Boolean
}
```
Response:
```
{ 
    data: {
        id: :Integer,
        dashboard_tab_id: :Integer,
        application_use_case: :JSON,
        sequence: :Integer,
        configured: :Boolean
    },
    message: "Widget Updated Successfully!"
}
```

****
- Create a custom event for user performed actions

**_Types:_**
- ContactSearch
- AccountSearch
- VerifyAccount
- VerifyContact
- ViewAccount
- ViewContact
****

- Create recent contact search event
**URL:**

**POST /api/v0/user_events**

Request Body:
```
{
    type: "ContactSearch",
    input: {
        contact_id: :Integer,
        criteria: {},
        contact_count: :Integer,
    }
}
```

- Get recent contact searches API

**URL:**

**GET /api/v0/contact_searches**

Response:

```
[
    {
        type: "ContactSearch",
        data: {
            contact_id: :Integer,
            criteria: {},
            count: :Integer,
        },
    },
]
```

- Create recent account search API

**URL:**

**POST /api/v0/user_events**

Request Body:

```
{
    {
        type: "AccountSearch",
        input: {
            account_id: :Integer,
            criteria: {},
            count: :Integer,
        },
    },
}
```

- Get recent account searches API

**URL:**

**GET /api/v0/search_accounts**

Response:

```
[
    {
        type: "AccountSearch",
        data: {
            account_id: :Integer,
            criteria: {},
            account_count: 123,
        },
    },
]
```

- Create recently viewed account API

**URL:**

**POST /api/v0/user_events**

Request Body:
```
{
    type: "ViewAccount",
    input: {
        account_id: :Integer
    }
}
```

- Get recently viewed accounts objects limit 5

**URL:**

**GET /api/v0/view_accounts**

```
[
    {
        type: "ViewAccount",
        data: {
            account_id: :Integer,
        }

    },
]
```

- Create recently viewed contact API

URL: POST /api/v0/user_events
```
{
    type: "ViewContact",
    input: {
        contact_id: :Integer,
    }
}
```

- Get recently viewed contact objects limit 5

**URL:**

**POST /api/v0/view_contacts**

```
[
    {
        type: "ViewContact",
        data: {
            contact_id: :Integer        
        }
    }
]
```

- Create recently verified contact API

**URL:**

**POST /api/v0/user_events**

Request Body:

```
{
    type: "VerifyContact",
    input: {
        contact_id: :Integer,
    }
}
```

- Get recently verified contact

**URL**

**GET /api/v0/verify_contacts**

Response

```
{
    type: "VerifyContact",
    data: {
        contact_id: :Integer,
    }
}
```

- Create recently verified contact API

**URL:**

**POST /api/v0/user_events**

Request Body:

```
{
    type: "VerifyAccount",
    input: {
        account_id: :Integer,
    }
}
```

- Get recently verified account

**URL**

**GET /api/v0/verify_account**

Response

```
{
    type: "VerifyAccount",
    data: {
        account_id: :Integer,
    }
}
```
****

- Get recent viewed companies API

URL: GET /api/v0/recently_viewed_companies
```
[{
    annual_cost_of_revenue: "165536.0"
    annual_gross_profit: "114986.0"
    annual_net_income: "11588.0"
    annual_operating_income: "11588.0"
    city_name: "Seattle"
    company_location: "2127 7th Ave., Seattle, WA, 98109, United States"
    contacts_count: 7759
    country_name: "United States"
    date_founded: null
    description: "Amazon is guided by four principles: customer obsession rather than competitor focus, passion for invention, commitment to operational excellence, and long-term thinking. We are driven by the excitement of building technologies, inventing products, and providing services that change lives. We embrace new ways of doing things, make decisions quickly, and are not afraid to fail. We have the scope and capabilities of a large company, and the spirit and heart of a small one.\n\nTogether, Amazonians research and develop new technologies from Amazon Web Services to Alexa on behalf of our customers: shoppers, sellers, content creators, and developers around the world.\n\nOur mission is to be Earth's most customer-centric company. Our actions, goals, projects, programs, and inventions begin and end with the customer top of mind.\n\nYou'll also hear us say that at Amazon, it's always \"Day 1.\"​ What do we mean? That our approach remains the same as it was on Amazon's very first day - to make smart, fast decisions, stay nimble, invent, and focus on delighting our customers."
    employee_low: 10001
    employee_range: "10001+"
    employees_linkedin: 573743
    es_seo_keywords: null
    es_web_technographics: null
    es_web_traffic_data: null
    fiscal_year: 2019
    homepage_url: "http://www.amazon.com"
    id: 1604
    industry: "Internet"
    is_fresh: true
    is_watchlisted: true
    li_updated_at: "2021-07-14T10:06:59.128Z"
    linkedin_name: "Amazon"
    linkedin_url: "https://www.linkedin.com/company/1586"
    location_area: "Seattle, US-WA, United States"
    logo_url: "https://dealsignal.s3.amazonaws.com/production/company/Amazon_1604.jpeg"
    name: "Amazon"
    phone: "+1 206 266 1000"
    revenue: "280522.0"
    revenue_high: null
    revenue_low: 1000
    sic_codes: "5961"
    sic_explanations: "Retail-Catalog and Mail-Order Houses"
    state_name: "WA"
    street_address: "2127 7th Ave."
    ticker: "AMZN",
    zip_code: "98109"
}]
```

- Get recent verified companies API

URL: GET /api/v0/recently_verified_companies
```
[{
    annual_cost_of_revenue: "165536.0"
    annual_gross_profit: "114986.0"
    annual_net_income: "11588.0"
    annual_operating_income: "11588.0"
    city_name: "Seattle"
    company_location: "2127 7th Ave., Seattle, WA, 98109, United States"
    contacts_count: 7759
    country_name: "United States"
    date_founded: null
    description: "Amazon is guided by four principles: customer obsession rather than competitor focus, passion for invention, commitment to operational excellence, and long-term thinking. We are driven by the excitement of building technologies, inventing products, and providing services that change lives. We embrace new ways of doing things, make decisions quickly, and are not afraid to fail. We have the scope and capabilities of a large company, and the spirit and heart of a small one.\n\nTogether, Amazonians research and develop new technologies from Amazon Web Services to Alexa on behalf of our customers: shoppers, sellers, content creators, and developers around the world.\n\nOur mission is to be Earth's most customer-centric company. Our actions, goals, projects, programs, and inventions begin and end with the customer top of mind.\n\nYou'll also hear us say that at Amazon, it's always \"Day 1.\"​ What do we mean? That our approach remains the same as it was on Amazon's very first day - to make smart, fast decisions, stay nimble, invent, and focus on delighting our customers."
    employee_low: 10001
    employee_range: "10001+"
    employees_linkedin: 573743
    es_seo_keywords: null
    es_web_technographics: null
    es_web_traffic_data: null
    fiscal_year: 2019
    homepage_url: "http://www.amazon.com"
    id: 1604
    industry: "Internet"
    is_fresh: true
    is_watchlisted: true
    li_updated_at: "2021-07-14T10:06:59.128Z"
    linkedin_name: "Amazon"
    linkedin_url: "https://www.linkedin.com/company/1586"
    location_area: "Seattle, US-WA, United States"
    logo_url: "https://dealsignal.s3.amazonaws.com/production/company/Amazon_1604.jpeg"
    name: "Amazon"
    phone: "+1 206 266 1000"
    revenue: "280522.0"
    revenue_high: null
    revenue_low: 1000
    sic_codes: "5961"
    sic_explanations: "Retail-Catalog and Mail-Order Houses"
    state_name: "WA"
    street_address: "2127 7th Ave."
    ticker: "AMZN",
    zip_code: "98109"
}]
```

- Get recent viewed contacts API

URL: GET /api/v0/recently_viewed_contacts
```
[{
    city_id: null
    company: {
        annual_cost_of_revenue: "17136.0"
        annual_gross_profit: "15000.0"
        annual_net_income: "4570.0"
        annual_operating_income: "4570.0"
        city_name: "St Paul"
        company_location: "3M Center, St Paul, MN, 55144, Us"
        country_name: "United States"
        date_founded: "1902-01-01"
        employee_low: 10001
        employee_range: "10001+",
        employees_linkedin: 64564
    }
    company_name: "3M"
    country_id: 1
    email: "mike.roman@3m.com"
    email_status: "Verified"
    email_status_order: null
    first_name: "Mike"
    headline: "Chairman of the Board at 3M"
    id: 10143069
    image_url: "https://media-exp1.licdn.com/dms/image/C4E03AQG3qEAL3B-Akg/profile-displayphoto-shrink_100_100/0/1548179259770?e=1637193600&v=beta&t=hk86aT1pa0Ju3Jnt4r971_4w530Wl5_8ccomcqpalNc"
    industry: "Electrical & Electronic Manufacturing"
    is_fresh: true
    is_watchlisted: true
    last_name: "Roman"
    li_updated_at: "2021-09-14T05:26:26.015Z"
    linkedin_url: "https://www.linkedin.com/in/mike-roman-7758204"
    location: "St Paul, Minnesota, United States"
    location_area: "US-MN, United States"
    logo_url: "https://dealsignal.s3.amazonaws.com/production/contact/Mike_Roman_10143069.jpeg"
    middle_name: null
    name: "Mike Roman"
    phone: "613-498-5900"
    phone_verified: true
    popularity: 51000
    remark: null
    search_data: "Mike Roman 3M"
    search_on_name: "Mike Roman"
    state_id: 24
    updated_at: "2021-09-20T17:53:23.563Z"
    valid_email: false
}]
```

- Get recent verified contacts API

URL: GET /api/v0/recently_verified_contacts
```
[{
    city_id: null
    company: {
        annual_cost_of_revenue: "17136.0"
        annual_gross_profit: "15000.0"
        annual_net_income: "4570.0"
        annual_operating_income: "4570.0"
        city_name: "St Paul"
        company_location: "3M Center, St Paul, MN, 55144, Us"
        country_name: "United States"
        date_founded: "1902-01-01"
        employee_low: 10001
        employee_range: "10001+",
        employees_linkedin: 64564
    }
    company_name: "3M"
    country_id: 1
    email: "mike.roman@3m.com"
    email_status: "Verified"
    email_status_order: null
    first_name: "Mike"
    headline: "Chairman of the Board at 3M"
    id: 10143069
    image_url: "https://media-exp1.licdn.com/dms/image/C4E03AQG3qEAL3B-Akg/profile-displayphoto-shrink_100_100/0/1548179259770?e=1637193600&v=beta&t=hk86aT1pa0Ju3Jnt4r971_4w530Wl5_8ccomcqpalNc"
    industry: "Electrical & Electronic Manufacturing"
    is_fresh: true
    is_watchlisted: true
    last_name: "Roman"
    li_updated_at: "2021-09-14T05:26:26.015Z"
    linkedin_url: "https://www.linkedin.com/in/mike-roman-7758204"
    location: "St Paul, Minnesota, United States"
    location_area: "US-MN, United States"
    logo_url: "https://dealsignal.s3.amazonaws.com/production/contact/Mike_Roman_10143069.jpeg"
    middle_name: null
    name: "Mike Roman"
    phone: "613-498-5900"
    phone_verified: true
    popularity: 51000
    remark: null
    search_data: "Mike Roman 3M"
    search_on_name: "Mike Roman"
    state_id: 24
    updated_at: "2021-09-20T17:53:23.563Z"
    valid_email: false
}]
```

- Get recent viewed contacts API

URL: GET /api/v0/recently_viewed_contacts
```
[{
    city_id: null
    company: {
        annual_cost_of_revenue: "17136.0"
        annual_gross_profit: "15000.0"
        annual_net_income: "4570.0"
        annual_operating_income: "4570.0"
        city_name: "St Paul"
        company_location: "3M Center, St Paul, MN, 55144, Us"
        country_name: "United States"
        date_founded: "1902-01-01"
        employee_low: 10001
        employee_range: "10001+",
        employees_linkedin: 64564
    }
    company_name: "3M"
    country_id: 1
    email: "mike.roman@3m.com"
    email_status: "Verified"
    email_status_order: null
    first_name: "Mike"
    headline: "Chairman of the Board at 3M"
    id: 10143069
    image_url: "https://media-exp1.licdn.com/dms/image/C4E03AQG3qEAL3B-Akg/profile-displayphoto-shrink_100_100/0/1548179259770?e=1637193600&v=beta&t=hk86aT1pa0Ju3Jnt4r971_4w530Wl5_8ccomcqpalNc"
    industry: "Electrical & Electronic Manufacturing"
    is_fresh: true
    is_watchlisted: true
    last_name: "Roman"
    li_updated_at: "2021-09-14T05:26:26.015Z"
    linkedin_url: "https://www.linkedin.com/in/mike-roman-7758204"
    location: "St Paul, Minnesota, United States"
    location_area: "US-MN, United States"
    logo_url: "https://dealsignal.s3.amazonaws.com/production/contact/Mike_Roman_10143069.jpeg"
    middle_name: null
    name: "Mike Roman"
    phone: "613-498-5900"
    phone_verified: true
    popularity: 51000
    remark: null
    search_data: "Mike Roman 3M"
    search_on_name: "Mike Roman"
    state_id: 24
    updated_at: "2021-09-20T17:53:23.563Z"
    valid_email: false
}]
```

- Get recent accounts, contacts & Searches API

URL: GET /api/v0/recently_verified_accounts_contacts_searches
```
[
    {
        type: "contact",
        city_id: null
        company: {
            annual_cost_of_revenue: "17136.0"
            annual_gross_profit: "15000.0"
            annual_net_income: "4570.0"
            annual_operating_income: "4570.0"
            city_name: "St Paul"
            company_location: "3M Center, St Paul, MN, 55144, Us"
            country_name: "United States"
            date_founded: "1902-01-01"
            employee_low: 10001
            employee_range: "10001+",
            employees_linkedin: 64564
        }
        company_name: "3M"
        country_id: 1
        email: "mike.roman@3m.com"
        email_status: "Verified"
        email_status_order: null
        first_name: "Mike"
        headline: "Chairman of the Board at 3M"
        id: 10143069
        image_url: "https://media-exp1.licdn.com/dms/image/C4E03AQG3qEAL3B-Akg/profile-displayphoto-shrink_100_100/0/1548179259770?e=1637193600&v=beta&t=hk86aT1pa0Ju3Jnt4r971_4w530Wl5_8ccomcqpalNc"
        industry: "Electrical & Electronic Manufacturing"
        is_fresh: true
        is_watchlisted: true
        last_name: "Roman"
        li_updated_at: "2021-09-14T05:26:26.015Z"
        linkedin_url: "https://www.linkedin.com/in/mike-roman-7758204"
        location: "St Paul, Minnesota, United States"
        location_area: "US-MN, United States"
        logo_url: "https://dealsignal.s3.amazonaws.com/production/contact/Mike_Roman_10143069.jpeg"
        middle_name: null
        name: "Mike Roman"
        phone: "613-498-5900"
        phone_verified: true
        popularity: 51000
        remark: null
        search_data: "Mike Roman 3M"
        search_on_name: "Mike Roman"
        state_id: 24
        updated_at: "2021-09-20T17:53:23.563Z"
        valid_email: false
    },
    {
        type: "contact",
        annual_cost_of_revenue: "165536.0"
        annual_gross_profit: "114986.0"
        annual_net_income: "11588.0"
        annual_operating_income: "11588.0"
        city_name: "Seattle"
        company_location: "2127 7th Ave., Seattle, WA, 98109, United States"
        contacts_count: 7759
        country_name: "United States"
        date_founded: null
        description: "Amazon is guided by four principles: customer obsession rather than competitor focus, passion for invention, commitment to operational excellence, and long-term thinking. We are driven by the excitement of building technologies, inventing products, and providing services that change lives. We embrace new ways of doing things, make decisions quickly, and are not afraid to fail. We have the scope and capabilities of a large company, and the spirit and heart of a small one.\n\nTogether, Amazonians research and develop new technologies from Amazon Web Services to Alexa on behalf of our customers: shoppers, sellers, content creators, and developers around the world.\n\nOur mission is to be Earth's most customer-centric company. Our actions, goals, projects, programs, and inventions begin and end with the customer top of mind.\n\nYou'll also hear us say that at Amazon, it's always \"Day 1.\"​ What do we mean? That our approach remains the same as it was on Amazon's very first day - to make smart, fast decisions, stay nimble, invent, and focus on delighting our customers."
        employee_low: 10001
        employee_range: "10001+"
        employees_linkedin: 573743
        es_seo_keywords: null
        es_web_technographics: null
        es_web_traffic_data: null
        fiscal_year: 2019
        homepage_url: "http://www.amazon.com"
        id: 1604
        industry: "Internet"
        is_fresh: true
        is_watchlisted: true
        li_updated_at: "2021-07-14T10:06:59.128Z"
        linkedin_name: "Amazon"
        linkedin_url: "https://www.linkedin.com/company/1586"
        location_area: "Seattle, US-WA, United States"
        logo_url: "https://dealsignal.s3.amazonaws.com/production/company/Amazon_1604.jpeg"
        name: "Amazon"
        phone: "+1 206 266 1000"
        revenue: "280522.0"
        revenue_high: null
        revenue_low: 1000
        sic_codes: "5961"
        sic_explanations: "Retail-Catalog and Mail-Order Houses"
        state_name: "WA"
        street_address: "2127 7th Ave."
        ticker: "AMZN",
        zip_code: "98109"
    },
    {
        type: "search",
        criteria: {},
        company_count: 123,
        name: 'Recent company search #001'
    }
]
```