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

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

Accommodation

Returns the list of available properties and their prices. The cost of this service is 125 credits for the first network + 100 credits per additional 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 125 credits per 625 properties and limited to 5,000 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

Account

Occasionally, you may want to keep track of your account's balance, the status of your webhooks and listeners, the count of active reviews or social media jobs.

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/listing/details** your payload will look like this `[{"network": "google", "slug": "my-listing"}]`.
 Below is the mapping of batch endpoints to regular endpoints:
| **Batch Endpoint** | **Original Endpoint** |
|-----------------|-------------------|
| /batch/listing/details | **[GET]** /listing/{network} |
| /batch/listing/find | **[GET]** /listing/find |
| /batch/listing/match | **[GET]** /listing/match |
| /batch/reviews | **[POST]** /reviews |
| /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 listing

Listing

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 Listings** and **Match Listing** endpoints.

Listing Details

Get the list of listings, 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 listing is found, the response contains a list of up to **10** listings 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 listing details which performs a more in-depth lookup.
 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.

Listings Lookup

Using the business name and address, find the exact business profile page on the list of networks of your choice. If the listing is found, this endpoint returns at most one review page per network representing the matching listing page. Data and content are the same as returned by the **Find Listing** 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

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

Reviews

Creates a new job to pull review data from the requested review page. The response will also include the listing's information.
 You can set your preferred level of monitoring:
<ul>
<li>None (default): This means that monitoring will not be enabled, i.e. reviews will not maintained up to date. We will return a fresh snapshot of the reviews without sourcing from our cached data. Data retention is set to 5 days. The cost per job is 50 credits + 1 credit per returned review. With this type of monitoring, you can set a <code>sizeLimit</code> and/or <code>dateLimit</code> (whichever comes first) to limit the number of returned reviews and consequently the cost. This type of jobs cannot be set for auto-renewal.</li>
<li>Basic: All the reviews are immediately made available once crawling is completed. Updates and fetching of new reviews is once every 30 days. The cost of this type of jobs is 75 credits + 3 credits per returned review. You can set this job to auto-renew. The cost of an auto-renewed job is 50 credits + 3 credits per returned new reviews. You do not get charged twice for an existing and previously returned review. You cannot set limits of any kind on this type of jobs. The original listing although it is included in the response, it is not guaranteed to be up to date. Edits, replies, deletions, restorations, and any changes affecting existing reviews are not guaranteed to be applied. The main purpose of this monitoring style is to ensure collecting new reviews on a monthly basis. This job remains active for 30 days.</li>
<li>Regular: All the reviews are immediately made available once crawling is completed. Updates and fetching of new reviews is once a day. The cost of this type of jobs is 125 credits + 3 credits per returned review. You can set this job to auto-renew. The cost of an auto-renewed job is 75 credits + 3 credits per returned new reviews. You do not get charged twice for an existing and previously returned review. You cannot set limits of any kind on this type of jobs. The original listing although it is included in the response, it is not guaranteed to be up to date. Edits, replies, deletions, restorations, and any changes affecting existing reviews are not guaranteed to be applied. The main purpose of this monitoring style is to ensure collecting new reviews on a daily basis. This job remains active for 30 days.</li>
<li>Full: The recommended monitoring level for online reputation management activities. The initial pull is processed through a priority queue to ensure minimum delay before delivery. Updates and fetching of new reviews are as frequent as the activity on the target listing with a guarantee of a maximum rest time of 8-12 hours (depends on the platform). The cost of this type of jobs is 150 credits + 1 credit per returned review. You can set this job to auto-renew. The cost of an auto-renewed job is 100 credits + 1 credit per returned reviews. You will be charged for all the reviews in each cycle because we are closely monitoring all the reviews. You will also receive updates for any affected existing review regardless of when it was initially pulled. You cannot set limits of any kind on this type of jobs. The original listing is kept up to date. This job remains active for 30 days.</li>
</ul>
Please note that all jobs with any kind of monitoring enabled will cause the pull of the entire set of reviews. Having a track of the reviews is crucial for our monitoring and collision detection process.
 All monitoring jobs remain valid for 30 days. If you desire to change the monitoring level, you must cancel the existing job then create a new job with the new monitoring level. You will lose all the previous data and you will be charged again for the new job independently from the history.
 There cannot be two active jobs with monitoring enabled. If you use a different slug for the same listing it will result in the same job being returned and no new job will be created.
 The review fetching starts promptly after creation and data is made available a few seconds later.
 If you have an endpoint listening to our webhook callback, expect the signal to be issued within a few seconds from the original request.

Create Review Job

Returns the list of reviews that were collected as requested in the review job. To retrieve a job, you must specify the `jobId`, `uid`, or the pair of `network` and `slug`. At least one of these params must be present in order to identify the record locally but not all. If you use the pair of `network` and `slug` then we will try to return the active monitoring job. If there is no job with monitoring enabled then we will return the most recent job without monitoring.

Get Reviews

Applies changes to an existing and active review job.

Update Review Job

Schedules an instant fetch job to pull reviews updates. The job is executed immediately. This helps instructing our engines to fetch reviews and return all new reviews and changes without waiting until the next scheduled crawl.
 By default, we pull updates for recent reviews only, i.e. `partial`. A minimum wait time of 1 minute has to observed before requesting to fetch reviews again. For full scans, the minimum wait time is 5 minutes.

Trigger Reviews Fetch

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

Delete Review Job

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

Social Media

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

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

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}** endpoint 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

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

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.

Authorization

resource

Unique resource identifier. Full URLs are not accepted. Varies by network. Here are a few examples per resource:
- **Better Business Bureau**:
  - Company: good-greek-moving-storage-0633-90312345
- **Facebook**:
  - Advertiser: 176105152520900
  - Page: Presidence.tn
  - Post: S:_I1391675561076747:3140064409571178 or 3140064409571178 or pfbid02ZZQHWhS4VQ3jwAN7FHbNtM5Hs1gAfkC6c6SoAkNvEsNNeY3e9gXVCKZPhg6WTnVTl
- **Glassdoor**:
  - Company: Working-at-Booz-Allen-Hamilton-EI_IE2735
- **Instagram**:
  - Hashtag: coupleprayer
  - Post: CFzAp7DASJ0
  - User: soumaya_belkouchi
- **LinkedIn**:
  - Company: zembra
  - Keyword: san+diego
  - Profile: bakayoko
  - Post: urn:li:ugcPost:6971444261015724033
- **Reddit**:
  - Keyword: sandiego
  - Post: 12mizot
  - Subreddit: Damnthatsinteresting
  - User: coastalJuncture
- **TikTok**:
  - Hashtag: healthy
  - User: justqueen1988
  - Video: 7114961878434041094


slug

message

Details of an online social media resource

data

Successfully returning details about the requested resource

Invalid token used to authenticate the call

The requested network is not enabled for your account. Contact your account manager or our support team to get it added to your list of enabled platforms.

This is your application's internal ID. It can help you identify the requested resource, particularly when you activate listeners and we send you a change notification.

internalId

Instructs the API to only collect up to this number of elements. For example, an Instagram post may have thousands of comments but you are only interested in the first 500. This will make the pulling process abort at the 500th element.

sizeLimit

Instructs the API to only collect elements posted after and not older than this timestamp in Unix format in seconds. For example, an Instagram post may have thousands of comments but you are only interested in those that were posted the last 24 hours. The pulling process will stop as soon as a collected comment is older than the given limit. All older comments are filtered out. The account is only charged for the eligible comments.

dateLimit

Depending on the selected network, this will define what data you want to stream. This is needed because under one source there could be more than one content type to be streamed. Example, for Instagram users, you may want to pull all comments or all reels.

content

Standard output of a new social media job

The ID of the job that was returned at the time of creating the job

jobId

Indicates the maximum number of elements to be returned. The default limit will be applied if omitted.

limit

Helps with pagination. It indicates the offset to be applied to the set of elements.

offset

Standard output with social media content

Successfully returning the list of stream elements for requested resource

Maximum number of jobs to be returned. At most 100 jobs will be returned even if this parameter is set to a higher value.

Helps with pagination. It controls the offset to be applied to the set of jobs.

sortBy

sortDirection

Filter results to only jobs with similar internal ID. This is the ID you set on the job that identifies it with your application. Please see the description of `internalId` in section **[GET] /social/{network}/{resource}/{slug}**.

Filter results to only jobs with similar slug. Please see the description of `slug` in section **[GET] /social/{network}/{resource}/{slug}**.

Returns jobs only from the requested network.

Limits jobs to only those that match the selected resource type.

Limits jobs to only those that match the selected content type.

By default, the API will return the active and unexpired records. Setting this input to `true` will allow returning deleted and expired records.

When a `sizeLimit` is set and a subscription reaches the defined limit we will stop fetching new data unless you explicitly allow pulling new content. Example, if you request TikTok video comments and set the `sizeLimit` to 100, our engine will deliver no more than 100 comments no matter how busy the post is. If you want the last 100 comments and any future comments posted after you created the subscription, then you can set `allowNewContent` to `true`.
 Consequently, you will receive additional comments but your account will be charged for those extra records. By default, this flag is disabled and it has to be explicitly set per subscription unless you have configured your account's default parameter to `true` from the **API Settings** page.

allowNewContent

Standard output of a new social media subscription

Please see the description of `internalId` in section **[GET] /social/{network}/{resource}/{slug}**

Successfully updated the settings of the subscription

The status parameter conveys the status of the API request, indicating whether it was successful or encountered an error.

status

The message parameter provides additional information or feedback related to the API request.

The elapsed parameter indicates the time duration it took to process the API request.

elapsed

Maximum number of subscriptions to be returned. At most 100 subscriptions will be returned even if this parameter is set to a higher value.

Helps with pagination. It controls the offset to be applied to the set of subscriptions.

Filter results to only subscriptions with similar internal ID. This is the ID you set on the subscription that identifies it in your application.

Filter results to only subscriptions to resources with similar slug.

Returns subscriptions only from the requested network.

Limits subscriptions to only those that match the selected resource type.

Limits subscriptions to only those that match the selected content type.

Successfully returning the list of social media subscriptions