analytics

Start a market analysis (async job)

Starts the analysis and returns the job (poll GET /v1/analytics/jobs/{job_id}). 409 price_confirmation_required when the high estimate exceeds max_price_usd (default $1); 402 when the prepaid balance cannot hold the high estimate (only the actual price is charged when the job ends; the rest of the hold goes back); 429 when the account already has two analyses running and two queued.

Workflows

Workflow market-analysis, step 3/4 start: Aggregate rate statistics for services across insurers and all providers in an area (benchmarking, research, negotiation prep, exports).

  • Purpose: Starts the job with the same inputs (409 price_confirmation_required = high estimate above max_price_usd).
  • Call after: estimate_market_analysis
  • Next: get_market_analysis
post/v1/analytics/jobs

Request

  • Base URL: https://api.ticexplorer.com
  • URL: https://api.ticexplorer.com/v1/analytics/jobs
  • Auth: HTTP bearer

Query parameters

wait_secondsinteger

Wait up to this long for the job to finish before answering (0 = return the job at once).

Request body

codesstring[] required

1-20 CPT/HCPCS codes from find_codes. Codes that hospitals are paid per APC also bring in the hospitals' APC case rates.

payersstring[]

Insurer names as people say them ("Premera", "Aetna", "Regence", "UnitedHealthcare", "Cigna", "Kaiser"), catalog payer ids, or ["major"] = the largest insurers in this market (major_payers of them).

major_payersinteger

How many insurers "major" means.

files_per_payerinteger

Most rate files read per insurer (in-area and most-used files first). More = more coverage, more first-time indexing (time, price).

index_new_filesboolean

false = read only files that are already indexed (fast, nearly free; coverage may be lower). true = also index the in-scope files that are not yet indexed.

providers'relevant' | 'all'

relevant = billing entities with evidence they provide the service (Medicare billing for the code, facility, hospital APC); all = also entities that merely hold a contracted rate.

include_providersboolean

Add the least / most expensive billing entities (name, TIN, site address, miles) to each result group.

providers_per_groupinteger
max_price_usdnumber nullable

Highest estimated usage charge (USD) the job may start with (default $1.00); above it the job is not started (409 price_confirmation_required).

Example request

{
  "geography": {
    "zip": "98052"
  }
}

Response

Successful Response

Open required

Changes

No recorded changes to this operation across all 1 revision of this API.