Birdeye · JSON-LD Context

Birdeye Context

JSON-LD context defining the semantic vocabulary for Birdeye from Birdeye.

279 Classes 18 Properties 2 Namespaces

Namespaces

birdeye: https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/vocabulary/birdeye-vocabulary.yml#

api: https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-birdeye-api-openapi.yml#

Classes

BusinessId EnterpriseBusinessNumber Level accessControl accountNumber active additionalImageLinks additionalInfo additionalMetaData additionalParams aggrOptions aggregationID aiModel aiModels alias allChild androidAppURL answer answerId apiKey appleListing appointmentLink assignedTo assignees astatus auth b_id bid bingListing blocked brandIds brandName businessID businessId businessIds businessInfo businessName businessNumber businessNumbers businessStatus business_Id business_id cardId categoryId category_name channel checkinId cid clickURL comment compAccountId comparisonFilter competitorId competitorLocationIds competitors contact contactType count countryCode coverBusinessInfoLayout coverImageUrl covidInfo currencyCode customFields customer customerComment customerId customfields days defaultValue deleteEndDate deleteStartDate description dropDownOptions duration email emailId emailOptin emailPreferences email_id emails employees end endDate endDateUtc endpoint entUser entityCategory establishedYear eventName events excludeCampaignMessages experienceScore externalId externalReferenceId facebookCover facebookListing fax fbCoverOptOut fbLogoOptOut fetchAssitedByDetails fetchExtraParams fieldDescription fieldId fieldName fieldValue filterable firstName fromDate fromTimestamp gmbCover gmbCoverOptOut gmbListing gmbLogoOptOut googleProductCategoryId group groupByDays groupByType healthcare hoursOfOperations id imageLink imagePosition imageURL impressum includeNonAggregatedReviews includeTicketId integrationGroupId integrationProperties internalListing iosAppURL isAddressHidden isCompetitor isHidden isPinOnTop isPrivateResponse isSEOEnabled isServiceAreaProvider isVisible keywords keywordsSearch lang languages lastName limit linkText localPhoneNumber location locationBizNumber locationsNumberAccess logoUrl media mediaCategory mediaId menuLink merchantId months name needCustomerInfo notification offset op optOut order orderAheadLink orderBy page pageNo pageNumber pageSize payment permission phone pid price productId productIdentifier productIds productSku productTypes productUrl products profileTabs question questionId ratings reopenDate reportType reservationLink response reviewId reviewSiteAllFlag reviewSites reviewSources rid sIndex salePrice scheduleTimestamp search searchStr selectedMonth selectedkeywords sendInvite sentiment serviceAreas serviceId serviceIds service_id services sindex size smsEnabled smsOptin smsPreferences socialProfileURLs socialSite sorder sortBy sortOrder sortby sortorder sourceAlias sourceAliases sourceName sourceNames sourceType sourceTypes sources specialHours start startDate startDateUtc startIndex status statuses subBusinessIds subBusinessNumbers subscriptionStatus surveyId surveyResponseId surveySettings survey_id tag tagNames tagname tags templateId text theme thirdPartyListing ticketId ticketStatuses ticketType ticketTypes ticketUpdateMessages timePeriodSelected timezone title toDate toTimestamp tollFreePhoneNumber topAd topKW topThm trackingId type updateFromDate updateToDate url user userEmail userEmailId userRole viewMode viewReportType webhookUrl websiteUrl working24x7 zip

Properties

Property	Type	Container
Aggregation	reference
Business	reference
Campaign	reference
Competitor	reference
Contact	reference
Conversation	reference
Employee	reference
FAQ	reference
Integration	reference
Listing	reference
Report	reference
Reviews	reference
Social	reference
Subscription	reference
Survey	reference
Ticketing	reference
User	reference
Webhook	reference

JSON-LD Document

{
  "@context": {
    "@vocab": "https://schema.org/",
    "birdeye": "https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/vocabulary/birdeye-vocabulary.yml#",
    "api": "https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-birdeye-api-openapi.yml#",
    "Aggregation": {
      "@id": "birdeye:Aggregation",
      "@type": "@id"
    },
    "Business": {
      "@id": "birdeye:Business",
      "@type": "@id"
    },
    "BusinessId": "birdeye:BusinessId",
    "Campaign": {
      "@id": "birdeye:Campaign",
      "@type": "@id"
    },
    "Competitor": {
      "@id": "birdeye:Competitor",
      "@type": "@id"
    },
    "Contact": {
      "@id": "birdeye:Contact",
      "@type": "@id"
    },
    "Conversation": {
      "@id": "birdeye:Conversation",
      "@type": "@id"
    },
    "Employee": {
      "@id": "birdeye:Employee",
      "@type": "@id"
    },
    "EnterpriseBusinessNumber": "birdeye:EnterpriseBusinessNumber",
    "FAQ": {
      "@id": "birdeye:FAQ",
      "@type": "@id"
    },
    "Integration": {
      "@id": "birdeye:Integration",
      "@type": "@id"
    },
    "Level": "birdeye:Level",
    "Listing": {
      "@id": "birdeye:Listing",
      "@type": "@id"
    },
    "Report": {
      "@id": "birdeye:Report",
      "@type": "@id"
    },
    "Reviews": {
      "@id": "birdeye:Reviews",
      "@type": "@id"
    },
    "Social": {
      "@id": "birdeye:Social",
      "@type": "@id"
    },
    "Subscription": {
      "@id": "birdeye:Subscription",
      "@type": "@id"
    },
    "Survey": {
      "@id": "birdeye:Survey",
      "@type": "@id"
    },
    "Ticketing": {
      "@id": "birdeye:Ticketing",
      "@type": "@id"
    },
    "User": {
      "@id": "birdeye:User",
      "@type": "@id"
    },
    "Webhook": {
      "@id": "birdeye:Webhook",
      "@type": "@id"
    },
    "accessControl": "birdeye:accessControl",
    "accountNumber": "birdeye:accountNumber",
    "active": "birdeye:active",
    "additionalImageLinks": "birdeye:additionalImageLinks",
    "additionalInfo": "birdeye:additionalInfo",
    "additionalMetaData": "birdeye:additionalMetaData",
    "additionalParams": "birdeye:additionalParams",
    "aggrOptions": "birdeye:aggrOptions",
    "aggregationID": "birdeye:aggregationID",
    "aiModel": "birdeye:aiModel",
    "aiModels": "birdeye:aiModels",
    "alias": "birdeye:alias",
    "allChild": "birdeye:allChild",
    "androidAppURL": "birdeye:androidAppURL",
    "answer": "birdeye:answer",
    "answerId": "birdeye:answerId",
    "apiKey": "birdeye:apiKey",
    "appleListing": "birdeye:appleListing",
    "appointmentLink": "birdeye:appointmentLink",
    "assignedTo": "birdeye:assignedTo",
    "assignees": "birdeye:assignees",
    "astatus": "birdeye:astatus",
    "auth": "birdeye:auth",
    "b_id": "birdeye:b_id",
    "bid": "birdeye:bid",
    "bingListing": "birdeye:bingListing",
    "blocked": "birdeye:blocked",
    "brandIds": "birdeye:brandIds",
    "brandName": "birdeye:brandName",
    "businessID": "birdeye:businessID",
    "businessId": "birdeye:businessId",
    "businessIds": "birdeye:businessIds",
    "businessInfo": "birdeye:businessInfo",
    "businessName": "birdeye:businessName",
    "businessNumber": "birdeye:businessNumber",
    "businessNumbers": "birdeye:businessNumbers",
    "businessStatus": "birdeye:businessStatus",
    "business_Id": "birdeye:business_Id",
    "business_id": "birdeye:business_id",
    "cardId": "birdeye:cardId",
    "categoryId": "birdeye:categoryId",
    "category_name": "birdeye:category_name",
    "channel": "birdeye:channel",
    "checkinId": "birdeye:checkinId",
    "cid": "birdeye:cid",
    "clickURL": "birdeye:clickURL",
    "comment": "birdeye:comment",
    "compAccountId": "birdeye:compAccountId",
    "comparisonFilter": "birdeye:comparisonFilter",
    "competitorId": "birdeye:competitorId",
    "competitorLocationIds": "birdeye:competitorLocationIds",
    "competitors": "birdeye:competitors",
    "contact": "birdeye:contact",
    "contactType": "birdeye:contactType",
    "count": "birdeye:count",
    "countryCode": "birdeye:countryCode",
    "coverBusinessInfoLayout": "birdeye:coverBusinessInfoLayout",
    "coverImageUrl": "birdeye:coverImageUrl",
    "covidInfo": "birdeye:covidInfo",
    "currencyCode": "birdeye:currencyCode",
    "customFields": "birdeye:customFields",
    "customer": "birdeye:customer",
    "customerComment": "birdeye:customerComment",
    "customerId": "birdeye:customerId",
    "customfields": "birdeye:customfields",
    "days": "birdeye:days",
    "defaultValue": "birdeye:defaultValue",
    "deleteEndDate": "birdeye:deleteEndDate",
    "deleteStartDate": "birdeye:deleteStartDate",
    "description": "birdeye:description",
    "dropDownOptions": "birdeye:dropDownOptions",
    "duration": "birdeye:duration",
    "email": "birdeye:email",
    "emailId": "birdeye:emailId",
    "emailOptin": "birdeye:emailOptin",
    "emailPreferences": "birdeye:emailPreferences",
    "email_id": "birdeye:email_id",
    "emails": "birdeye:emails",
    "employees": "birdeye:employees",
    "end": "birdeye:end",
    "endDate": "birdeye:endDate",
    "endDateUtc": "birdeye:endDateUtc",
    "endpoint": "birdeye:endpoint",
    "entUser": "birdeye:entUser",
    "entityCategory": "birdeye:entityCategory",
    "establishedYear": "birdeye:establishedYear",
    "eventName": "birdeye:eventName",
    "events": "birdeye:events",
    "excludeCampaignMessages": "birdeye:excludeCampaignMessages",
    "experienceScore": "birdeye:experienceScore",
    "externalId": "birdeye:externalId",
    "externalReferenceId": "birdeye:externalReferenceId",
    "facebookCover": "birdeye:facebookCover",
    "facebookListing": "birdeye:facebookListing",
    "fax": "birdeye:fax",
    "fbCoverOptOut": "birdeye:fbCoverOptOut",
    "fbLogoOptOut": "birdeye:fbLogoOptOut",
    "fetchAssitedByDetails": "birdeye:fetchAssitedByDetails",
    "fetchExtraParams": "birdeye:fetchExtraParams",
    "fieldDescription": "birdeye:fieldDescription",
    "fieldId": "birdeye:fieldId",
    "fieldName": "birdeye:fieldName",
    "fieldValue": "birdeye:fieldValue",
    "filterable": "birdeye:filterable",
    "firstName": "birdeye:firstName",
    "fromDate": "birdeye:fromDate",
    "fromTimestamp": "birdeye:fromTimestamp",
    "gmbCover": "birdeye:gmbCover",
    "gmbCoverOptOut": "birdeye:gmbCoverOptOut",
    "gmbListing": "birdeye:gmbListing",
    "gmbLogoOptOut": "birdeye:gmbLogoOptOut",
    "googleProductCategoryId": "birdeye:googleProductCategoryId",
    "group": "birdeye:group",
    "groupByDays": "birdeye:groupByDays",
    "groupByType": "birdeye:groupByType",
    "healthcare": "birdeye:healthcare",
    "hoursOfOperations": "birdeye:hoursOfOperations",
    "id": "birdeye:id",
    "imageLink": "birdeye:imageLink",
    "imagePosition": "birdeye:imagePosition",
    "imageURL": "birdeye:imageURL",
    "impressum": "birdeye:impressum",
    "includeNonAggregatedReviews": "birdeye:includeNonAggregatedReviews",
    "includeTicketId": "birdeye:includeTicketId",
    "integrationGroupId": "birdeye:integrationGroupId",
    "integrationProperties": "birdeye:integrationProperties",
    "internalListing": "birdeye:internalListing",
    "iosAppURL": "birdeye:iosAppURL",
    "isAddressHidden": "birdeye:isAddressHidden",
    "isCompetitor": "birdeye:isCompetitor",
    "isHidden": "birdeye:isHidden",
    "isPinOnTop": "birdeye:isPinOnTop",
    "isPrivateResponse": "birdeye:isPrivateResponse",
    "isSEOEnabled": "birdeye:isSEOEnabled",
    "isServiceAreaProvider": "birdeye:isServiceAreaProvider",
    "isVisible": "birdeye:isVisible",
    "keywords": "birdeye:keywords",
    "keywordsSearch": "birdeye:keywordsSearch",
    "lang": "birdeye:lang",
    "languages": "birdeye:languages",
    "lastName": "birdeye:lastName",
    "limit": "birdeye:limit",
    "linkText": "birdeye:linkText",
    "localPhoneNumber": "birdeye:localPhoneNumber",
    "location": "birdeye:location",
    "locationBizNumber": "birdeye:locationBizNumber",
    "locationsNumberAccess": "birdeye:locationsNumberAccess",
    "logoUrl": "birdeye:logoUrl",
    "media": "birdeye:media",
    "mediaCategory": "birdeye:mediaCategory",
    "mediaId": "birdeye:mediaId",
    "menuLink": "birdeye:menuLink",
    "merchantId": "birdeye:merchantId",
    "months": "birdeye:months",
    "name": "birdeye:name",
    "needCustomerInfo": "birdeye:needCustomerInfo",
    "notification": "birdeye:notification",
    "offset": "birdeye:offset",
    "op": "birdeye:op",
    "optOut": "birdeye:optOut",
    "order": "birdeye:order",
    "orderAheadLink": "birdeye:orderAheadLink",
    "orderBy": "birdeye:orderBy",
    "page": "birdeye:page",
    "pageNo": "birdeye:pageNo",
    "pageNumber": "birdeye:pageNumber",
    "pageSize": "birdeye:pageSize",
    "payment": "birdeye:payment",
    "permission": "birdeye:permission",
    "phone": "birdeye:phone",
    "pid": "birdeye:pid",
    "price": "birdeye:price",
    "productId": "birdeye:productId",
    "productIdentifier": "birdeye:productIdentifier",
    "productIds": "birdeye:productIds",
    "productSku": "birdeye:productSku",
    "productTypes": "birdeye:productTypes",
    "productUrl": "birdeye:productUrl",
    "products": "birdeye:products",
    "profileTabs": "birdeye:profileTabs",
    "question": "birdeye:question",
    "questionId": "birdeye:questionId",
    "ratings": "birdeye:ratings",
    "reopenDate": "birdeye:reopenDate",
    "reportType": "birdeye:reportType",
    "reservationLink": "birdeye:reservationLink",
    "response": "birdeye:response",
    "reviewId": "birdeye:reviewId",
    "reviewSiteAllFlag": "birdeye:reviewSiteAllFlag",
    "reviewSites": "birdeye:reviewSites",
    "reviewSources": "birdeye:reviewSources",
    "rid": "birdeye:rid",
    "sIndex": "birdeye:sIndex",
    "salePrice": "birdeye:salePrice",
    "scheduleTimestamp": "birdeye:scheduleTimestamp",
    "search": "birdeye:search",
    "searchStr": "birdeye:searchStr",
    "selectedMonth": "birdeye:selectedMonth",
    "selectedkeywords": "birdeye:selectedkeywords",
    "sendInvite": "birdeye:sendInvite",
    "sentiment": "birdeye:sentiment",
    "serviceAreas": "birdeye:serviceAreas",
    "serviceId": "birdeye:serviceId",
    "serviceIds": "birdeye:serviceIds",
    "service_id": "birdeye:service_id",
    "services": "birdeye:services",
    "sindex": "birdeye:sindex",
    "size": "birdeye:size",
    "smsEnabled": "birdeye:smsEnabled",
    "smsOptin": "birdeye:smsOptin",
    "smsPreferences": "birdeye:smsPreferences",
    "socialProfileURLs": "birdeye:socialProfileURLs",
    "socialSite": "birdeye:socialSite",
    "sorder": "birdeye:sorder",
    "sortBy": "birdeye:sortBy",
    "sortOrder": "birdeye:sortOrder",
    "sortby": "birdeye:sortby",
    "sortorder": "birdeye:sortorder",
    "sourceAlias": "birdeye:sourceAlias",
    "sourceAliases": "birdeye:sourceAliases",
    "sourceName": "birdeye:sourceName",
    "sourceNames": "birdeye:sourceNames",
    "sourceType": "birdeye:sourceType",
    "sourceTypes": "birdeye:sourceTypes",
    "sources": "birdeye:sources",
    "specialHours": "birdeye:specialHours",
    "start": "birdeye:start",
    "startDate": "birdeye:startDate",
    "startDateUtc": "birdeye:startDateUtc",
    "startIndex": "birdeye:startIndex",
    "status": "birdeye:status",
    "statuses": "birdeye:statuses",
    "subBusinessIds": "birdeye:subBusinessIds",
    "subBusinessNumbers": "birdeye:subBusinessNumbers",
    "subscriptionStatus": "birdeye:subscriptionStatus",
    "surveyId": "birdeye:surveyId",
    "surveyResponseId": "birdeye:surveyResponseId",
    "surveySettings": "birdeye:surveySettings",
    "survey_id": "birdeye:survey_id",
    "tag": "birdeye:tag",
    "tagNames": "birdeye:tagNames",
    "tagname": "birdeye:tagname",
    "tags": "birdeye:tags",
    "templateId": "birdeye:templateId",
    "text": "birdeye:text",
    "theme": "birdeye:theme",
    "thirdPartyListing": "birdeye:thirdPartyListing",
    "ticketId": "birdeye:ticketId",
    "ticketStatuses": "birdeye:ticketStatuses",
    "ticketType": "birdeye:ticketType",
    "ticketTypes": "birdeye:ticketTypes",
    "ticketUpdateMessages": "birdeye:ticketUpdateMessages",
    "timePeriodSelected": "birdeye:timePeriodSelected",
    "timezone": "birdeye:timezone",
    "title": "birdeye:title",
    "toDate": "birdeye:toDate",
    "toTimestamp": "birdeye:toTimestamp",
    "tollFreePhoneNumber": "birdeye:tollFreePhoneNumber",
    "topAd": "birdeye:topAd",
    "topKW": "birdeye:topKW",
    "topThm": "birdeye:topThm",
    "trackingId": "birdeye:trackingId",
    "type": "birdeye:type",
    "updateFromDate": "birdeye:updateFromDate",
    "updateToDate": "birdeye:updateToDate",
    "url": "birdeye:url",
    "user": "birdeye:user",
    "userEmail": "birdeye:userEmail",
    "userEmailId": "birdeye:userEmailId",
    "userRole": "birdeye:userRole",
    "viewMode": "birdeye:viewMode",
    "viewReportType": "birdeye:viewReportType",
    "webhookUrl": "birdeye:webhookUrl",
    "websiteUrl": "birdeye:websiteUrl",
    "working24x7": "birdeye:working24x7",
    "zip": "birdeye:zip"
  },
  "@type": "APIVocabulary",
  "name": "Birdeye API Context",
  "description": "JSON-LD context for the Birdeye reputation management and customer experience API.",
  "url": "https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/json-ld/birdeye-context.jsonld",
  "api": "https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-birdeye-api-openapi.yml",
  "version": "1.0.0"
}