Get Listing Optimizer report for a listing | PriceLabs

{
  "data": {
    "listing_id": "123456789",
    "pms_name": "airbnb",
    "overall_score": 7.85,
    "scores": {
      "overall_score": 91,
      "listing_title": {
        "score": "A",
        "improvements": "Add a specific location detail to stand out in search."
      },
      "listing_description": {
        "score": "B",
        "improvements": "Mention nearby attractions to improve discoverability."
      },
      "image_score": {
        "score": "A",
        "improvements": "Add a photo of the outdoor space."
      },
      "amenities": {
        "score": "C",
        "description": "Missing a few amenities guests filter on, like a washer/dryer."
      },
      "review_count": {
        "score": "B",
        "description": "Fewer reviews than top-performing comparable listings."
      },
      "review_summary": {
        "score": "B",
        "improvements": "Recent reviews mention slow check-in communication."
      },
      "star_rating": {
        "score": "B",
        "description": "Above the neighborhood average, below the top decile."
      },
      "guest_favorite": {
        "score": "B",
        "description": "Not yet a Guest Favorite; close to the threshold."
      },
      "consistency_score": {
        "score": "B",
        "improvements": "Pricing varies more than similar high-performing listings."
      }
    },
    "previous_scores": {
      "overall_score": 88.5,
      "listing_title": {
        "score": "A"
      },
      "listing_description": {
        "score": "B"
      },
      "image_score": {
        "score": "B"
      },
      "amenities": {
        "score": "C"
      },
      "review_count": {
        "score": "B"
      },
      "review_summary": {
        "score": "B"
      },
      "star_rating": {
        "score": "B"
      },
      "guest_favorite": {
        "score": "B"
      },
      "consistency_score": {
        "score": "B"
      }
    }
  }
}

Returns full Listing Optimizer details for a single Airbnb listing: category letter grades, score breakdowns, improvement tips, and previous-run grades for comparison.

Requires listing_id as a query parameter. Optionally accepts pms_name as a query parameter (defaults to airbnb). If the account has not paid for Optimizer access for this listing, payment_restricted: true is returned and score data is omitted.

Returns full Listing Optimizer details for a single Airbnb listing: category letter grades, score breakdowns, improvement tips, and previous-run grades for comparison. Requires `listing_id` as a query parameter. Optionally accepts `pms_name` as a query parameter (defaults to `airbnb`). If the account has not paid for Optimizer access for this listing, `payment_restricted: true` is returned and score data is omitted.

Query parameters

listing_idstringRequired

Listing ID of the Airbnb listing.

pms_namestringOptional

PMS name. Defaults to airbnb.

Response

Listing Optimizer report retrieved successfully.

dataobject

Listing Optimizer report for the listing.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -G https://api.pricelabs.co/v1/listing_optimizer/report \
>	-H "X-API-Key: {{API_KEY}}" \
>	-d listing_id=123456789

Headers

Query parameters

Response

Errors