API Facebook - POST Method /create

Allows creating new Workers with their keywords.

What is a Worker?

A Worker in TrawlingWeb is an entity configured by the user to perform specific searches on social networks using Keywords. These Keywords are search terms configured within the Worker and are based on contracted credits (1 credit = 1 Keyword).

Creation and Configuration of Workers

Users can create and define search terms for each Worker directly on the dashboard (https://dashboard.trawlingweb.com/workers) or using the method provided by the API. Once a Worker is created, it begins its deployment to start its configuration task, which may take up to an hour.

Functionality of Workers

• Keywords: Workers operate as a list of keywords. They use configured Keywords to perform searches on social networks.

• Search process: Workers deliver the keywords to TrawlingWeb spiders to execute searches on the social network.
• Delivery process: Each time the client calls the Worker, it uses the list of keywords to launch the search against the database of results obtained by TrawlingWeb and retrieve only those results related to the list of keywords.

Efficiently implementing and managing Workers allows users to maximize the relevance and accuracy of processed data, adapting to the specific needs of their social media analysis and monitoring.

POST Parameters

Let's examine the structure of the example query:

https://facebook.trawlingweb.com/create/?token={APIKEY}

PATH Parameters:

QUERY Parameters:

BODY Parameters:

Structure of the words parameter

The words parameter must be sent as a JSON array of text strings, where each array element represents a Keyword. Each Keyword can contain advanced Facebook syntax (hashtags, mentions, boolean operators, etc.).

Example body in JSON format:

{
  "description": "Example Worker for brand monitoring",
  "words": [
    "cocacola",
    "#pepsi",
    "@cocacola",
    "Cocacola (__) Pepsi",
    "\"cocacola with ice\""
  ]
}

In this example, the Worker is created with 5 Keywords:

1. A simple word: "cocacola"
2. A hashtag: "#pepsi"
3. A mention: "@cocacola"
4. An OR search using (): "Cocacola () Pepsi"
5. An exact search in quotes: "cocacola with ice"

Each element in the words array consumes 1 credit (1 credit = 1 Keyword).

Output Response - RESPONSE

Upon making a request to the Facebook API, it will return a structured response as follows:

Status 200 - Return Data

Example response in json format:

json
"response" : {
    "worker" : "...",
    "msg" : "..."
}

Status 400 - Return Data

Example response in json format:

json
"response" : {
    "error" : "..."
}

Enhanced Search with Facebook Syntax

Facebook employs its own advanced syntax for executing specific and detailed searches within its platform. This syntax allows filtering results by keywords, hashtags, mentions, locations, dates, among other parameters. Furthermore, when defining keywords for a Worker, this syntax can be used to launch precise queries against Facebook's search engine. This maximizes the efficiency and relevance of the data processed by each Worker, facilitating more effective monitoring and analysis of conversations on Facebook.

Here is a list of elements you can combine with your keywords when creating them within a worker:

Reserved Characters in Search Words

Reserved characters include: + - = & | > < ! ¡ () {} [] ^ " ~ * ¿ ?: \ / ' -

Contact

If you have any questions, need assistance, want to hire or expand your services, please contact us.

Technical Support (SAT):

• SAT Email
• Official Documentation

Administrative Support (SAC):

• SAC Email

Sales Support (Sales):

• Sales Email