Elasticsearch DSL: Employee Posts API

Data type:

Query type:

URL:

Employee Posts

Elasticsearch DSL

https://api.coresignal.com/cdapi/v2/employee_post/search/es_dsl

---

Overview

Use the /v2/employee_post/search/es_dsl endpoint for more sophisticated queries.

Additionally, the endpoint allows you to operate filters that mimic our employee posts data, enabling you to write more sophisticated queries than using the /v2/employee_post/search/filter endpoint.

General Elasticsearch DSL information and usage tips

Elasticsearch schema

Elasticsearch schema

Elastic schema

{
    "mappings": {
        "properties": {
            "id": {
                "type": "keyword"
            },
            "url": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "author_name": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "author_profile_url": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "employee_parent_id":{
                "type": "long"
            },
            "author_headline": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "author_posts_count": {
                "type": "long"
            },
            "date_published": {
                "type": "date",
                "format": "yyyy-MM-dd"
            },
            "article_body": {
                "type": "text"
            },
            "image_url": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "hashtags": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "mentions": {
                "type": "nested",
                "properties": {
                    "full_name": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "url": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    }
                }
            },
            "reaction_count": {
                "type": "long"
            },
            "comment_count": {
                "type": "long"
            },
            "comments": {
                "type": "nested",
                "properties": {
                    "full_name": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "headline": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "profile_url": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "body": {
                        "type": "text"
                    },
                    "reaction_count": {
                        "type": "long"
                    },
                    "date_published": {
                        "type": "date",
                        "format": "yyyy-MM-dd"
                    }
                }
            },
            "reshared_post": {
                "type": "nested",
                "properties": {
                    "id": {
                        "type": "keyword"
                    },
                    "url": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "author_name": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "author_profile_url": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "employee_parent_id":{
                        "type": "long"
                    },
                    "author_headline": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    },
                    "date_published": {
                        "type": "date",
                        "format": "yyyy-MM-dd"
                    },
                    "article_body": {
                        "type": "text"
                    },
                    "image_url": {
                        "type": "text",
                        "index": false
                    },
                    "hashtags": {
                        "type": "text",
                        "fields": {
                            "exact": {
                                "type": "keyword"
                            }
                        }
                    }
                }
            }
        }
    }
}

Sample request

Request example

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/employee_post/search/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "query":{
      "match":{
         "author_name":{
            "query":"John Smith",
            "operator":"and"
         }
      }
   }
}'

Sorting options

Find several examples of the available sorting options. All information about the sorting is in the general Elasticsearch DSL topic.

Sort by ID

Sort by ID

{
    "query": {
        "match": {
            "author_name":{
                "query":"John Smith",
                "operator": "and"
            }
        }
    },
    "sort": [
        "id"
    ]
}

Sort by score

Sort by score

{
    "query": {
        "match": {
            "author_name":{
                "query":"John Smith",
                "operator": "and"
            }
        }
    },
    "sort": [
        "_score"
    ]
}