CrowdTangle
The CrowdTangle Connector provides automated access to the CrowdTangle API.
Prerequisites
You will need to create a CrowdTangle Key in the Key Editor with the following property:
- API Token
- If you have access to the API, you can locate your API token via your dashboard under Settings > API Access.
Scheduling
The CrowdTangle Connector can be scheduled to ingest data on an hourly basis.
See Hourly Scheduling for more information.
Posts
Sample Switchboard Script
download t from {
type: "crowdtangle:posts";
key: "crowdtangle_key";
# Allows hourly schedule
} using {*};
Posts Search
Unlike the main “Posts” report, this report searches the entire cross-platform CrowdTangle system of posts.
It lets you search the entire CT database with search terms.
Parameters
- search_term string
- optional
- Returns only posts that match the given search term.
- By default individual terms (i.e. words separated by spaces) are treated as being combined with the word “AND” (e.g. in the search phrase
CrowdTangle API
both “CrowdTangle” and “API” must match in the text of the post). Separate terms with commas (e.g.CrowdTangle, API
) to treat them as “OR” conditions so that either term appearing will be considered as a match. Use quotes for phrases (e.g."CrowdTangle API"
) to match the two terms in that exact order. - filter_and string
- optional
- Post search is split into OR, AND and NOT chunks. This is the AND section. Each is a phrase match, meaning that if the search_term is “CrowdTangle, API” and filter_and is “so fast, great documentation,” it will search for ((“CrowdTangle” AND “so fast” AND “great documentation”) OR (“API” AND “so fast” AND “great documentation”)).
- filter_not string
- optional
- A corollary to filter_and, filter_not will exclude all posts matching this word/phrase.
Sample Switchboard Script
download t from {
type: "crowdtangle:posts_search";
key: "crowdtangle_key";
# Optional; Returns only posts that match this search term. Terms AND automatically. Separate with commas for OR, use quotes for phrases. E.g. CrowdTangle API -> AND. CrowdTangle, API -> OR. "CrowdTangle API" -> AND in that exact order.
search_term: <some_string>
# Optional; Post search is split into OR, AND and NOT chunks. This is the AND section. Each is a phrase match, meaning that searchTerm is "CrowdTangle, API" and filter_and is "so fast, great documentation," it will search for (("CrowdTangle" AND "so fast" AND "great documentation") OR ("API" AND "so fast" AND "great documentation")).
filter_and: <some_string>
# Optional; A corollary to filter_and, filter_not will exclude all posts matching this word/phrase.
filter_not: <some_string>
# Allows hourly schedule
} using {*};