Readiness

Markdown

The publish checklist of a guide.

Fields

productIdstring · guide idrequired
The guide's id.
namestringrequired
The guide's title.
statusstringrequired
draft, published or archived.
draftpublishedarchived
canPublishbooleanrequired
true when no publish gate is open.
blockingarray of PublishGaterequired
The publish gates that are open: the same check publishing enforces.
Show 2 fieldsHide fieldsof PublishGate
- codestringrequired
  Which gate is open.
  agreement_outdatedno_spotsmissing_coordinatesmissing_photosno_price
- messagestringrequired
  What to fix, in plain words.
warningsarray of objectsrequired
Checks that do not block a publish but deserve a look.
Show 2 fieldsHide fields
- codestringrequired
  A stable code for the warning (see the readiness guide for the list).
- messagestringrequired
  What it means, in plain words.
checksobjectrequired
The rows behind each warning and gate.
Show 29 fieldsHide fields
- staleFactsarray of StaleFactrequired
  Dated facts past their dates.
  Show 7 fieldsHide fieldsof StaleFact
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field that needs a new check (fees, status, schedule, reviewBy ...).
  reasonstringrequired
  Why it is listed.
  review_dueendednot_checked_recently
  datestring or nullrequired
  The date that passed (YYYY-MM-DD).
  detailstringrequired
  What ran out, in plain words.
- reviewNotesarray of objectsrequired
  Every reviewNotes entry in the guide.
  Show 4 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplaceroutephoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  notestringrequired
  The review note.
- spotsWithoutSourcesnumberrequired
  Live spots without any source.
- linksobjectrequired
  Link health (get_link_report has every link).
  Show 4 fieldsHide fields
  totalnumberrequired
  Links buyers can open.
  flaggedarray of objectsrequired
  Links that look dead, parked or redirected.
  Show 5 fieldsHide fields
  urlstringrequired
  The link.
  statestringrequired
  Its state (broken, suspicious, tls, redirected).
  reasonstring or nullrequired
  Why, in words.
  finalUrlstring or nullrequired
  Where a redirect ends.
  usedByarray of objectsrequired
  Where the link is used.
  Show 3 fieldsHide fields
  kindstringrequired
  The kind of row.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field that holds the link.
  unverifiablenumberrequired
  Links on sites that turn scripts away.
  uncheckednumberrequired
  Links not checked yet.
- photosobjectrequired
  Photo checks.
  Show 4 fieldsHide fields
  farFromPinarray of objectsrequired
  Photos with a precise location more than 2 km from the pin.
  Show 6 fieldsHide fields
  kindstringrequired
  Always photo.
  spotplacerouteareaphoto
  idstringrequired
  The photo's id.
  namestringrequired
  The photo's caption or file.
  spotIdstringrequired
  The spot the photo belongs to.
  spotTitlestringrequired
  The spot's title.
  detailstringrequired
  What looks wrong.
  judgementarray of objectsrequired
  Photos whose location needs the creator's judgement.
  Show 6 fieldsHide fields
  kindstringrequired
  Always photo.
  spotplacerouteareaphoto
  idstringrequired
  The photo's id.
  namestringrequired
  The photo's caption or file.
  spotIdstringrequired
  The spot the photo belongs to.
  spotTitlestringrequired
  The spot's title.
  detailstringrequired
  What looks wrong.
  beforeChangearray of objectsrequired
  Photos captured before the spot's siteChange.
  Show 6 fieldsHide fields
  kindstringrequired
  Always photo.
  spotplacerouteareaphoto
  idstringrequired
  The photo's id.
  namestringrequired
  The photo's caption or file.
  spotIdstringrequired
  The spot the photo belongs to.
  spotTitlestringrequired
  The spot's title.
  detailstringrequired
  What looks wrong.
  nearDuplicatesarray of objectsrequired
  Photos that look like another photo of the guide.
  Show 6 fieldsHide fields
  kindstringrequired
  Always photo.
  spotplacerouteareaphoto
  idstringrequired
  The photo's id.
  namestringrequired
  The photo's caption or file.
  spotIdstringrequired
  The spot the photo belongs to.
  spotTitlestringrequired
  The spot's title.
  detailstringrequired
  What looks wrong.
- placesobjectrequired
  Place checks.
  Show 4 fieldsHide fields
  farFromSpotsarray of objectsrequired
  Places far from the spots they serve.
  Show 4 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  detailstringrequired
  What looks wrong.
  zoneDiffersarray of objectsrequired
  Places in another time zone than their spot.
  Show 4 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  detailstringrequired
  What looks wrong.
  distanceTooShortarray of objectsrequired
  Stated distances shorter than the straight line.
  Show 4 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  detailstringrequired
  What looks wrong.
  searchLinksarray of objectsrequired
  Map links that are a text search (they can open a namesake).
  Show 4 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  detailstringrequired
  What looks wrong.
- textobjectrequired
  Text checks.
  Show 3 fieldsHide fields
  pastDatesarray of objectsrequired
  Dates in the text that have passed.
  Show 5 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field the text is in.
  detailstringrequired
  What looks wrong.
  monthMismatcharray of objectsrequired
  Best months in the text missing from a month property.
  Show 5 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field the text is in.
  detailstringrequired
  What looks wrong.
  directionsarray of objectsrequired
  Directions that disagree with the pins.
  Show 5 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field the text is in.
  detailstringrequired
  What looks wrong.
- lightarray of objectsrequired
  Best light outside the opening hours.
  Show 5 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field the text is in.
  detailstringrequired
  What looks wrong.
- pinsarray of objectsrequired
  Extra pins far from their spot.
  Show 5 fieldsHide fields
  kindstringrequired
  The kind of row.
  spotplacerouteareaphoto
  idstringrequired
  The row's id.
  namestringrequired
  The row's name.
  fieldstringrequired
  The field the text is in.
  detailstringrequired
  What looks wrong.
- agreementCurrentbooleanrequired
  Whether the creator accepted the current agreement.
- spotCountnumberrequired
  Live spots.
- archivedSpotCountnumberrequired
  Archived spots.
- missingCoordinatesarray of objectsrequired
  Live spots without a pin.
  Show 2 fieldsHide fields
  spotIdstring · spot idrequired
  The spot's id.
  titlestringrequired
  The spot's title.
- coordinateOutliersarray of objectsrequired
  Spots unusually far from the others.
  Show 3 fieldsHide fields
  spotIdstring · spot idrequired
  The spot's id.
  titlestringrequired
  The spot's title.
  distanceKmnumberrequired
  Distance from the guide's center in kilometers.
- outlierThresholdKmnumberrequired
  The distance above which a spot counts as an outlier.
- outsideRegionarray of objectsrequired
  Spots outside the region's bbox.
  Show 2 fieldsHide fields
  spotIdstring · spot idrequired
  The spot's id.
  titlestringrequired
  The spot's title.
- spotsWithoutPhotosarray of objectsrequired
  Live spots with photos on but none uploaded.
  Show 2 fieldsHide fields
  spotIdstring · spot idrequired
  The spot's id.
  titlestringrequired
  The spot's title.
- spotsWithoutTextarray of objectsrequired
  Spots without a short or a long description.
  Show 2 fieldsHide fields
  spotIdstring · spot idrequired
  The spot's id.
  titlestringrequired
  The spot's title.
- photoCountnumberrequired
  Photos in the guide.
- photosWithoutCreditnumberrequired
  Photos without a credit.
- priceobject or nullrequired
  The active price.
  Show 2 fieldsHide fields
  amountMinornumberrequired
  The price in minor units (2900 is 29.00).
  currencystringrequired
  ISO 4217 code in lower case (usd, eur, chf).
- chapterCountnumberrequired
  Chapters and collections.
- routeCountnumberrequired
  Routes.
- regionMapRegion or nullrequired
  The map region.
  Show 5 fieldsHide fieldsof MapRegion
  labelstringoptional
  A name buyers recognise for the region, at most 120 characters (Hokkaido, the Dolomites).
  centerLatnumberoptional
  Latitude of the opening center (-90 to 90), usually the middle of the spots.
  centerLonnumberoptional
  Longitude of the opening center (-180 to 180).
  defaultZoomnumberoptional
  The opening zoom level, 0 to 22; 8 to 11 suits a region.
  bboxarray of numbersoptional
  The bounding box as [west, south, east, north] in decimal degrees, exactly four numbers. It should contain every spot: readiness flags spots outside it.
- storeTagsarray of stringsrequired
  Store tags.
- countrystring or nullrequired
  Country code, or null for worldwide.
- hasThumbnailbooleanrequired
  Whether a store thumbnail is set.
- salesPageobjectrequired
  The sales page.
  Show 3 fieldsHide fields
  draftProblemsarray of stringsrequired
  What the sales page draft still lacks.
  existsbooleanrequired
  Whether a sales page draft exists.
  publishedbooleanrequired
  Whether the sales page is published.
- lastApiWriteAtnumber or nullrequired
  When a key last changed the guide.
handoffobjectrequired
What the creator does in the studio.
Show 3 fieldsHide fields
- remainingarray of stringsrequired
  The clicks only the creator can make, still open.
- studioUrlstringrequired
  Where the creator publishes the guide.
- salesPageUrlstringrequired
  Where the creator publishes the sales page.
reviewUrlstringrequired
The guide in the studio, for the creator's review.
nextStepstringrequired
One sentence on what to do next.

Used by

get_guide_readiness