APIHub
Back to Explore

StatSocial Platform API

The StatSocial Platform API enables developers to create, customize, and fetch social‑media analytics reports—including tweet, follower, and custom reports—by providing filters, uploading handle lists, and querying report status, dates, and outputs.

Social
apiKeyHeader
No HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

725ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/applications/status/

Used to understand API usage

  • key (query, required) — User application key
GET

/reports/

Obtain report output

  • report_hash (query, required) — Unique report hash
  • baseline (query) — Default value will be 'world'
  • report_date (query) — report_date represents a Unix timestamp of when the report was generated. Default value will be the latest report generated. You can request the /report/dates/ endpoint in order to obtain available timestamps. Date must be in the future.
  • sample (query, required) — Sample report indicator
POST

/reports/

Obtain report output

  • report_hash (query, required) — Unique report hash
  • baseline (query) — Default value will be 'world'
  • report_date (query) — report_date represents a Unix timestamp of when the report was generated. Default value will be the latest report generated. You can request the /report/dates/ endpoint in order to obtain available timestamps. Date must be in the future.
  • sample (query, required) — Sample report indicator
GET

/reports/custom/create/

Step 3 of executing custom report

  • upload_hash (query, required) — Upload hash to be used for inserting handles
  • filter (query) — Filtering options to be used when creating a filtered report. The options must be in JSON form, example: {'gender':['male'],'ages':['18-24'],'countries':['usa']}
POST

/reports/custom/create/

Step 3 of executing custom report

  • upload_hash (query, required) — Upload hash to be used for inserting handles
  • filter (query) — Filtering options to be used when creating a filtered report. The options must be in JSON form, example: {'gender':['male'],'ages':['18-24'],'countries':['usa']}
GET

/reports/custom/generate/

Step 1 of executing custom report

  • report_name (query, required) — Name of the report
POST

/reports/custom/generate/

Step 1 of executing custom report

  • report_name (query, required) — Name of the report
GET

/reports/custom/insert/

Step 2 of executing custom report

  • upload_hash (query, required) — Upload hash to be used for inserting handles
  • ids (query, required) — List of twitter ids, separated by commas, to be inserted into report. Ids must be enclosed with brackets ie. [177490485] or [177490485,23423434]
POST

/reports/custom/insert/

Step 2 of executing custom report

  • upload_hash (query, required) — Upload hash to be used for inserting handles
  • ids (query, required) — List of twitter ids, separated by commas, to be inserted into report. Ids must be enclosed with brackets ie. [177490485] or [177490485,23423434]
GET

/reports/dates/

Get report dates available for a specific report

  • report_hash (query, required) — Unique report hash
POST

/reports/dates/

Get report dates available for a specific report

  • report_hash (query, required) — Unique report hash
GET

/reports/status/

Get list of generated reports

  • report_hash (query, required) — Unique hash belonging to report
POST

/reports/status/

Get list of generated reports

  • report_hash (query, required) — Unique hash belonging to report
GET

/reports/tweet/create/

Used to create tweet reports

  • report_name (query, required) — Name of report
  • start_date (query, required) — A unix timestamp. start_date will be set to the previous midnight.
  • end_date (query, required) — A unix timestamp. end_date will be set to the next midnight.
  • terms (query, required) — If you are tracking a single term, then the keyword itself is suffice otherwise, tracking multiple terms must be in JSON form, example '[{"operator":"","word":"http://google.com"},{"operator":"or","word":"#test"},{"operator":"and","word":"test2"}]' Which results in filtering tweets containing 'http://google.com' OR '#test' AND 'test2'. (NOTE) Make sure to URL encode the terms value for multiple terms.
  • filter (query) — Filtering options to be used when creating a filtered report. The options must be in JSON form, example: {'gender':['male'],'ages':['18-24'],'countries':['usa']}
POST

/reports/tweet/create/

Used to create tweet reports

  • report_name (query, required) — Name of report
  • start_date (query, required) — A unix timestamp. start_date will be set to the previous midnight.
  • end_date (query, required) — A unix timestamp. end_date will be set to the next midnight.
  • terms (query, required) — If you are tracking a single term, then the keyword itself is suffice otherwise, tracking multiple terms must be in JSON form, example '[{"operator":"","word":"http://google.com"},{"operator":"or","word":"#test"},{"operator":"and","word":"test2"}]' Which results in filtering tweets containing 'http://google.com' OR '#test' AND 'test2'. (NOTE) Make sure to URL encode the terms value for multiple terms.
  • filter (query) — Filtering options to be used when creating a filtered report. The options must be in JSON form, example: {'gender':['male'],'ages':['18-24'],'countries':['usa']}
GET

/reports/twitter/create/

Used to create twitter follower report

  • twitter_id (query) — (required if twitter_handle is not supplied) twitter_id must be sent with all client requests. Multiple handles are separated by commas.
  • twitter_handle (query) — (required if twitter_id is not supplied) twitter_handle must be sent with all client requests. Multiple ids are separated by commas.
  • filter (query) — Filtering options to be used when creating a filtered report. The options must be in JSON form, example: {'gender':['male'],'ages':['18-24'],'countries':['usa']}
POST

/reports/twitter/create/

Used to create twitter follower report

  • twitter_id (query) — (required if twitter_handle is not supplied) twitter_id must be sent with all client requests. Multiple handles are separated by commas.
  • twitter_handle (query) — (required if twitter_id is not supplied) twitter_handle must be sent with all client requests. Multiple ids are separated by commas.
  • filter (query) — Filtering options to be used when creating a filtered report. The options must be in JSON form, example: {'gender':['male'],'ages':['18-24'],'countries':['usa']}

17 endpoints auto-detected

Authentication

This API uses an API key, passed in the "api_key" header. No OAuth required.

curl -X GET \
  "http://api.statsocial.com/api/applications/status/" \
  -H "api_key: YOUR_API_KEY"

api.statsocial.com · HTTPS only