5622831410

This api is for the retrieval of industry metrics. It is also capable of retrieveing metrics on a company, product and drug class level.

Authenticating 

Certain metrics require authentication to access. These metrics are generally on the company or product level and require a valid valuetrak login.

Authentication (541) 971-3392

Authenticate A ValueTrak Or Regular User
/api/user/authenticate

Upon succesfull authentication, a temporary api key will be generated, which you will need to include in the header of your requests, to access non-public metrics

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "username": "mikehenken",
        "password": "profile"
    }
    
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    {
        "data": {
            "id": "1",
            "user_id": "1",
            "key": "7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0",
            "level": "1",
            "ignore_limits": "0",
            "created_at": {
            "date": "2014-12-04 21:42:41.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": {
            "date": "2014-12-04 21:42:41.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        }
    }
    

Days On hand 

Public:

  • Industry

Require Authorization:

  • Company

  • Product

Industry 

Industry
/api/metrics/doh/industry/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Company (502) 320-3220

Company
/api/metrics/doh/company/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Product manageability

Product
/api/metrics/doh/product/{product_id}
  • Parameters
  • product_id
    string (required) Example: 61144211

    The NDCUPC code for a product of which the authorized user is the owner of

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Returns Ratio 

Public:

  • Industry

Require Authorization:

  • Company

  • Product

Industry 

Industry
/api/metrics/returnsratio/industry/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Company 

Company
/api/metrics/returnsratio/company/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Product (402) 787-2504

Product
/api/metrics/returnsratio/product/{product_id}
  • Parameters
  • product_id
    string (required) Example: 61144211

    The NDCUPC code for a product of which the authorized user is the owner of

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Service Level 

Public:

  • Industry

Require Authorization:

  • Company

  • Product

Industry 

Industry
/api/metrics/servicelevel/industry/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Company 

Company
/api/metrics/servicelevel/company/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Product (269) 588-8505

Product
/api/metrics/servicelevel/product/{product_id}
  • Parameters
  • product_id
    string (required) Example: 61144211

    The NDCUPC code for a product of which the authorized user is the owner of

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Service Level As A Result of Days On Hand 

Public:

  • Industry

Require Authorization:

  • Company

Industry 

Industry
/api/metrics/serviceleveldoh/industry/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

Company pachyglossia

Company
/api/metrics/serviceleveldoh/company/{market_segment}

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Parameters
  • market_segment
    string (required) Example: branded

    The market segment.

  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
        "2012-01-06",
        42.69
        ],
        [
        "2012-01-10",
        42.21
        ],
        [
        "2012-01-11",
        42.35
        ],
        [
        "2012-01-12",
        42.2
        ]
    ]
    

New Product Launch (631) 864-8607

Public:

  • Industry

Industry 

Industry
/api/metrics/npl/industry/overall

Compatible Market Segments:

  • Generic

  • Branded

  • Specialty

  • Overall

  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
            1,
            4533
        ],
        [
            2,
            50072
        ],
        [
            3,
            17355
        ],
        [
            4,
            14092
        ],
        [
            5,
            8501
        ],
        [
            6,
            10201
        ],
        [
            7,
            13657
        ],
        [
            8,
            14074
        ],
        [
            9,
            14217
        ],
        [
            10,
            17818
        ],
        [
            11,
            21690
        ],
        [
            12,
            23453
        ],
        [
            13,
            23791
        ],
        [
            14,
            27584
        ],
        [
            15,
            28603
        ],
        [
            16,
            32308
        ],
        [
            17,
            30168
        ],
        [
            18,
            33386
        ],
        [
            19,
            33270
        ],
        [
            20,
            36766
        ]
    ]
    

Demand Variability 

Public:

  • Industry

Require Authorization:

  • Company

Industry 

Industry
/api/metrics/demandvariability/industry/overall

Compatible Market Segments:

  • Overall
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
            "2012-01-01",
            5345881.41
        ],
        [
            "2012-01-08",
            4941097.35
        ],
        [
            "2012-01-15",
            4693298
        ],
        [
            "2012-01-22",
            4936974.28
        ],
        [
            "2012-01-29",
            5257963.99
        ],
        [
            "2012-02-05",
            5023197.1
        ],
        [
            "2012-02-12",
            5028259.08
        ],
        [
            "2012-02-19",
            4877528.4
        ],
        [
            "2012-02-26",
            5210605.14
        ]
    ]
    

Company oxamethane

Company
/api/metrics/demandvariability/company/overall

Compatible Market Segments:

  • Overall
  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        [
            "2012-01-01",
            5345881.41
        ],
        [
            "2012-01-08",
            4941097.35
        ],
        [
            "2012-01-15",
            4693298
        ],
        [
            "2012-01-22",
            4936974.28
        ],
        [
            "2012-01-29",
            5257963.99
        ],
        [
            "2012-02-05",
            5023197.1
        ],
        [
            "2012-02-12",
            5028259.08
        ],
        [
            "2012-02-19",
            4877528.4
        ],
        [
            "2012-02-26",
            5210605.14
        ]
    ]
    

Sales Penetration By Region 765-344-0828

Require Authorization:

  • Company

Company 

Company
/api/metrics/salespenetrationregion/company/overall

Compatible Market Segments:

  • Overall
  • Request  Plain Text Message
  • Headers
    X-Authorization: 7bb6df33ccfdb6e3c771f5f6ffe76899886f21e0
  • Response  201
  • Headers
    Content-Type: application/json
    Body
    [
        ["2013-10-01",10544,"Midwest"],
        ["2013-10-01",1904,"New England"],
        ["2013-10-01",8368,"Northeast"],
        ["2013-10-01",14593,"Southeast"],
        ["2013-10-01",5054,"Southwest"],
        ["2013-10-01",8163,"West"]
    ]