Zembra

Zembra API Documentation

Zembra provides a RESTful API that supports common HTTP verbs and returns JSON-formatted responses with common HTTP status codes.
 You can use the sandbox token and endpoints for testing. The sandbox environment is isolated and will not impact your account balance. Nevertheless, the same rate limiting applies to both live and sandbox environments combined. The sandbox randomly returns dummy data representing all different expected responses from an endpoint. The sandbox performs the same set of validation the live box does, including slug validation and eligibility for services.
 Default rate limiting is set to **100** requests per minute. This limit may vary based on your account settings. If unsure, contact your account manager or reach out to our [support team](mailto:contact@zembratech.com).
 Each response returned by the API has rate limiting info added to the headers:
- **X-RateLimit-Limit**: 100 or -1 if no limit.
 The allocated rate limit to the account.
- **X-RateLimit-Remaining**: < 100 or -1 if no limit.
 The number of remaining calls before hitting the rate limiting limit and start getting calls rejected until the counter is reset.

Zembra has made SDKs available in many coding languages to help you quickly get started consuming the API with minimum effort:
- [C-Sharp](https://cdn.sdks.zembratech.com/zembra-sdk-csharp.zip)
- [Elixir](https://cdn.sdks.zembratech.com/zembra-sdk-elixir.zip)
- [Go](https://cdn.sdks.zembratech.com/zembra-sdk-go.zip)
- [Java](https://cdn.sdks.zembratech.com/zembra-sdk-java.zip)
- [Javascript](https://cdn.sdks.zembratech.com/zembra-sdk-javascript.zip)
- [Kotlin](https://cdn.sdks.zembratech.com/zembra-sdk-kotlin.zip)
- [PHP](https://cdn.sdks.zembratech.com/zembra-sdk-php.zip)
- [Python](https://cdn.sdks.zembratech.com/zembra-sdk-python.zip)
- [Ruby on Rails](https://cdn.sdks.zembratech.com/zembra-sdk-ruby-on-rails.zip)
- [Scala](https://cdn.sdks.zembratech.com/zembra-sdk-scala-akka.zip)
- [Swift 5](https://cdn.sdks.zembratech.com/zembra-sdk-swift5.zip)
- [Typescript](https://cdn.sdks.zembratech.com/zembra-sdk-typescript.zip)

You can also download [Postman](https://www.postman.com/downloads/) then import this [collection](https://cdn.sdks.zembratech.com/zembra-postman-collection.json) which includes calls the all Zembra API sandbox endpoints with a combination of all available parameters.

Welcome to Zembra API Documentation

Ping

A quick way to confirm that the server is up and running and to check the current API version

Check Server

Authentication and access token generation

Authentication

The API token never expires but you can renew it as needed. The API token is a 128-character string made of latin letters, both uppercase and lowercase, and digits. The API token is case-sensitive. API token should always be kept private and never shared with other third parties.
 When hitting the sandbox, this action will only affect the sandbox token.

Refresh API Token

Account

Occasionally, you may want to keep track of your account's balance, the status of your webhooks and listeners, or maybe the count of active subscriptions for listings or social media resources.

Get Account Summary

Submit one batch of up to 1,000 requests per service

Batch

Instead of running parallel requests or looping over your records and submitting one request at a time, you can choose to submit up to 1,000 requests in bulk. The server will pre-validate the inputs and accept all valid requests from the batch.
 Every request included in the batch will be processed and its result stored and if applicable delivered to your listeners. You can always retrieve the output of each request individually.
 To prevent congestion, you can only submit 1 batch per minute.
 Same options from the original endpoint can be used. Example, for **[POST] /batch/business/details** your payload will look like this `[{"network": "google", "slug": "my-business"}]`.
 Below is the mapping of batch endpoints to regular endpoints:
| **Batch Endpoint** | **Original Endpoint** |
|-----------------|-------------------|
| /batch/business/details | **[GET]** /business/{network} |
| /batch/business/find | **[GET]** /business/find |
| /batch/business/match | **[GET]** /business/match |
| /batch/reviews/job | **[POST]** /reviews/job/{network} |
| /batch/reviews/subscription | **[POST]** /reviews/subscription/{network} |
| /batch/social/details | **[POST]** /social/{network}/{resource}/{slug} |
| /batch/social/job | **[POST]** /social/job/{network}/{resource}/{slug}/{content} |
| /batch/social/subscription | **[POST]** /social/subscription/{network}/{resource}/{slug}/{content} |

Create Batch

This endpoint will provide details about the batch like requested time, overall progress, list of completed requests, etc.

Get Batch Status

Get the status and, if completed, the result of a request.

Get Batch Entry Result

Get the list of all the batches previously accepted.

Get Batch List

Search, match, and get details for a specific business

Business

Get the list of businesses, i.e. review pages, that match the search query from the given list of networks. The search query consists of the name of the business or its category, and optionally the address. If the business is found, the response contains a list of up to **10** businesses per network. You can also limit the list of fields to be returned. Data like images, exact address, review count, etc. might be missing on some networks. This service returns fewer details compared to querying business details which performs a more in-depth lookup.
 Please note that networks **Expedia**, **Orbitz**, and **Travelocity** belong to the same group and use the same data and format. As a result, you might be getting data for *Expedia* showing URL on Orbitz but all info and reviews are valid and taken straight from the requested source.

Listing Lookup

Using the business name and address, find the exact business profile page on the list of networks of your choice. If the business is found, this endpoint returns at most one review page per network representing the matching business page. Data and content are the same as returned by the **Find Business** endpoint.
 This service is great for finding the exact pages of the same business on multiple platforms at once. The match is guaranteed to be precise. There could be some misses due to insufficient data to confirm the match.

Listing Match

Returns information about the business as presented on the requested network. On a few networks, data like exact address (Glassdoor) or images might be missing. The information returned by this endpoint is richer than data returned by the **Find Business** and **Match Business** endpoints.

Listing Details

Get reviews data as an instant snapshot of its current state without updates

Review Jobs

Creates a new job to pull review data from the requested review page without creating a subscription. Data retention is set to 5 days. Reviews are not maintained up to date. The payload will be identical to the origin at the time of request. This is a snapshot of the current state of the reviews at the time of request.

Create Review Job

Returns the list of reviews that were collected as requested in the review job.

Get Reviews by Job ID

Returns the list of review jobs of the account. The result includes details about the job like requested time, internal ID, etc. The maximum number of returned jobs is 100 but you may use the `limit` and `offset` parameters for pagination.

Get Review Jobs List

Get reviews data and maintain data up to date with the origin for 30 days

Reviews Subscriptions

Returns the list of reviews for the requested business along with details of the subscription, and a summary of the review page including the review count, global rating, and the `lastCrawled` timestamp that indicates the date and time reviews from that target review page were pulled/checked.
 If the data is fully loaded in our system, you will get a **200 OK**. However, if the pulling is still in progress, expect to get a **206 Partial Content**. This last response will include whatever data has been collected thus far.
 You can call this endpoint as many times as you want within the lifespan of the subscription. You can also apply filters to return only a subset of the data. Some fields may not be supported on some networks. They are either set to `null` or omitted.

Get Reviews by Slug

Schedules an instant fetch job to pull reviews updates.
 By default, we pull updates for recent reviews. A minimum wait time of 1 minute has to observed before force fetching reviews again. For full scans, the minimum wait time is 5 minutes.

Trigger Reviews Fetch by Slug

Creates a new subscription to the requested review page. The subscription lasts 30 days. Requested reviews are maintained up to date with the origin. We monitor all changes introduced to the original review, e.g. change in rating, in text, etc. Data is kept current with a maximum of a 6 hour-gap with the source.
 All calls during the lifespan of the subscription to pull the data are free of charge. The cost of the subscription is based on the number of reviews which gets charged once per subscription including renewals. There is a base service fee that gets added regardless of the number or returned reviews. There are no tiers per network. The same pricing applies to all networks.
 If accepted, the response will include details about the requested business and the `subscription` object with the requested settings. Once the subscription is created and if you desire to get the reviews data, you can call the **[GET] /reviews/subscription/{network}** or **[GET] /reviews/subscription/uid/{uid}** endpoints to retrieve the data.
 You may need to allow a few minutes before getting the full list of reviews. It takes as little as 1 second or sometimes 50 seconds for an average page (~300 reviews) to be ready for delivery. Occasionally, the wait time may increase to 2 minutes and very rarely higher based on the **selected network**, the **number of reviews**, and the status of the **review platform servers**.
 Once the data is fully ready, it will be delivered in chunks of up to 100 reviews per call to your webhook if you have it configured to receive data for **new reviews** event.

Create Review Subscription

Introduces changes to an existing and active subscription to a review page.

Update Review Subscription by Slug

Completely delete a subscription. This action is not reversible. In the scenario you re-request to create a subscription to the same review page, you will be charged a new fee like if the previous and deleted subscription had never existed. You will also immediately stop receiving updates. We will stop monitoring updates.

Delete Review Subscription by Slug

Please see the description in section **[GET] /reviews/subscription/{network}**

Get Reviews by UID

Please see the description in section **[PUT] /reviews/subscription/{network}**

Trigger Reviews Fetch by UID

Please see the description in section **[PATCH] /reviews/subscription/{network}**

Update Review Subscription by UID

Please see the description in section **[DELETE] /reviews/subscription/{network}**

Delete Review Subscription by UID

Returns the list of reviews subscriptions of the account. The result includes details about the subscription like requested time, internal ID, etc. The maximum number of returned subscriptions is 100 but you may use the `limit` and `offset` parameters for pagination.

Get Review Subscriptions List

Get details about a post, a profile, a hashtag, etc.

Social Media Details

Returns details about social content like an Instagram post, TikTok video, LinkedIn post, etc. The response will include quasi-standard format across networks in addition to the original `rawData` collected from the source. Examples of collected data from an Instagram post are the slug, id, text, username, number of comments, number of likes, etc.

Get Social Media Resource Details

Capture an instant snapshot of a social media stream like post comments, company users, hashtag posts, etc.

Social Media Jobs

Creates a new job to stream data from the requested social media resource. It could be the comments list of an Instagram post or something similar. Data retention is set to 5 days. The data is not maintained up to date. The payload will be identical to the origin at the time of request. This is a snapshot of the current state of the requested resource.
 If sizeLimit and/or dateLimit parameters are set, the streaming will be stopped as soon as one of the conditions is met. If none of these parameters is present, the streaming will continue until all content is downloaded. Omitting both parameters may cause your account to accrue large charges with busy sources.

Create Social Media Job

Returns the list of elements (posts, comments, etc.) that were collected as requested in the job.

Get Contents by job ID

Returns the list of social media jobs of the account. The result includes details about the job like requested time, internal ID, etc. The maximum number of returned jobs is 100 but you may use the `limit` and `offset` parameters for pagination.

Get Social Media Jobs List

Stream and keep up to date social media streams like post comments, company users, hashtag posts, etc.

Social Media Subscriptions

Returns the list of elements for the requested resource along with details of the subscription.
 If the data is fully loaded in our system, you will get a **200 OK**. However, if the pulling is still in progress, expect to get a **206 Partial Content**. This last response will include whatever data has been collected thus far. You can call this endpoint as many times as you want within the lifespan of the subscription.
 If you have webhooks or listeners enabled, you will start receiving data in chunks right away. Contrary to reviews where the data is received as a summary or in a form of digests including all the reviews, with social streams the data is forwarded to your servers on the fly in chunks of 20 to 50 elements at a time. There are no daily digests or summaries.
 Social networks operate differently compared to review networks. They apply a chaining mechanism even when using API integration. As a consequence, when requesting a stream of a large size, you may experience delay due to serial data sourcing.
 Data retention is set to 5 days as the day this documentation is generated. During the data retention period, you can query the API as many times as you want to request the data without being charged.
 We will monitor the requested resource for updates with a minimum rest time of 3 hours.
 Contents are always returned sorted by timestamp descending.
 If `sizeLimit` and/or `dateLimit` parameters are set, the streaming will be stopped as soon as one of the conditions is met. If none of these parameters is present, the streaming will continue until all content is downloaded. Omitting both parameters may cause your account to accrue large charges with busy sources.

Get Contents by Slug

Creates a new subscription to the requested social media resource stream. The subscription lasts 5 days. We monitor the resource for added elements, e.g. new comments posted. Data is kept current with a maximum of an 8 hour-gap with the source depending on how busy the source is.
 All calls during the lifespan of the subscription to pull the data are free of charge. The cost of the subscription is based on the number of elements streamed in addition to a base service fee. There are no tiers per network. The same pricing applies to all networks.
 If accepted, the response will include details about the requested resource and the `subscription` object with the requested settings. Once the subscription is created and if you desire to get the stream data, you can call the **[GET] /social/subscription/{network}/{resource}/{slug}/{content}** or **[GET] /social/subscription/uid/{uid}** endpoints to retrieve the data.
 You may need to allow a few minutes before getting the full list of elements. It takes as little as 1 second or sometimes 5 minutes for an average resource (~5000 comments) to be ready for delivery. Occasionally, the wait time may increase to 30 minutes and very rarely higher based on the **selected network**, the **number of elements**, and the status of the **social media platform servers**.
 Once the data is fully ready, it will be delivered in chunks of up to 100 elements per call to your webhook.

Create Social Media Subscription

Introduces changes to an existing and active subscription to a social media resource.

Update Social Media Subscription by Slug

Completely delete a subscription. This action is not reversible. In the scenario you re-request to create a subscription to the same social media resource, you will be charged a new fee like if the previous and deleted subscription had never existed. You will also immediately stop receiving updates. We will stop monitoring updates.

Delete Social Media Subscription by Slug

Please see the description in section **[GET] /social/subscription/{network}/{resource}/{slug}/{content}**

Get Contents by UID

Please see the description in section **[PATCH] /social/subscription/{network}/{resource}/{slug}/{content}**

Update Social Media Subscription by UID

Please see the description in section **[DELETE] /social/subscription/{network}/{resource}/{slug}/{content}**

Delete Social Media Subscription by UID

Returns the list of social media subscriptions of the account. The result includes details about the subscription like requested time, internal ID, etc. The maximum number of returned subscriptions is 100 but you may use the `limit` and `offset` parameters for pagination.

Get Social Media Subscriptions List

Fetch hotel and other properties availability, details, and quotes.

Accommodations

Returns the list of available properties and their prices. The cost of this service is 100 credits per requested network.

Get Property Details by Name

Returns the list of available properties and their prices by ids. If the property is sold out, is closed, has a minimum stay policy, or requires more rooms to fit the requested number of guests, it is likely that the selected date range will not return result. The cost of this service is 100 credits and limited to 500 property ids per request.

Get Property Details by ID

Returns the list of prices for the given property for each of the requested dates if the property is available. If the property is sold out, is closed, has a minimum stay policy, or requires more rooms to fit the requested number of guests, it is likely that the selected date range will not return result. The cost of this service is 100 credits and limited to 500 date ranges per request.

Get Property Pricing by Date Range

Return the status of each supported platform.

Status

Due to relatively recent changes introduced by the originating websites, some platforms may experience down time while our team is actively working on rolling out required patches. In the meantime, you might be interested in programmatically checking the status of our supported networks.
 For more details, please visit [https://status.zembra.io/](https://status.zembra.io/)

Get Platforms Status

Blank

Live [master]

Zembra RESTful API supports common HTTP verbs and returns JSON-formatted responses with common HTTP status codes.