⚡Quick Start

Discover Phrazor in Minutes: Jumpstart Your Data Analysis

1. Get your API Key

Go to platform.phrazor.ai to create your account. After registration, you will get access to your account's Dashboard where you will find your unique API key.

2. Install the package using pip

pip install phrazor

** Please ensure that you have Python version 3.6 or higher installed.

3. Generate your first set of Insights

Copy the code provided below and replace the API Key with the one that you have generated in Step 1 and Save into a file, then execute the file to generate your initial set of insights.

import phrazor

phrazor.API_KEY = "YOUR API KEY"
phrzr = phrazor.Phrazor()

phrzr.set_data({
  "Sales Person": [
    "John Doe",
    "Mike Johnson",
    "Sarah Brown",
    "John Doe",
    "Mike Johnson",
    "Sarah Brown",
    "John Doe",
    "Mike Johnson",
    "Sarah Brown"
  ],
  "Date": [
    "2023-01-01T10:00:00",
    "2023-01-01T10:15:00",
    "2023-01-01T10:30:00",
    "2023-02-01T11:00:00",
    "2023-02-01T11:15:00",
    "2023-02-01T11:30:00",
    "2023-03-01T12:00:00",
    "2023-03-01T12:15:00",
    "2023-03-01T12:30:00"
  ],
  "Sales": [
    500,
    300,
    100,
    1000,
    250,
    90,
    750,
    380,
    250
  ]
})

phrzr.set_column_meta(
  date_column="Date", 
  metric_column="Sales", 
  dimension_column="Sales Person"
)

insights = phrzr.get_insights('descriptor')

print(insights)

Output Response

Output response would look something like this:

{
  "sections": [
    {
      "name": "Sales",
      "insights": [
        {
          "title": "Overall Sales Performance",
          "sentence": "Since January-2023, Sales was 3.62K.",
          "type": "generated"
        },
        {
          "title": "Best Performing Sales Person",
          "sentence": "Out of 3 Sales Person(s) Sales for John Doe was highest at 2.25K since January-2023.",
          "type": "generated"
        },
        {
          "title": "Under Performing Sales Person",
          "sentence": "Out of 3 Sales Person(s) in the last 3 months, Sarah Brown was the bottom Sales Person having Sales of 440.0.",
          "type": "generated"
        },
        {
          "title": "Most Contributing Sales Person",
          "sentence": "Out of 3 Sales Person(s) John Doe had the highest contribution (62.15%) for Sales in the last 3 months.",
          "type": "generated"
        },
        {
          "title": "Least Contributing Sales Person",
          "sentence": "Out of 3 Sales Person(s) since January-2023, Sarah Brown was the bottom Sales Person having 12.15% contribution in terms of Sales.",
          "type": "generated"
        },
        {
          "title": "Top Ranked Sales Person",
          "sentence": "Since January-2023, John Doe ranked 1st in terms of Sales (2.25K).",
          "type": "generated"
        }
      ]
    }
  ],
  "time_taken": 2.109931707382202
}

For more description on the response keys you can go to here.