get_audience
POST/v1/tools/get_audience
Return the audience profile of a project: monthly visits averaged over the last twelve months, unique visitors, deduplicated audience, annual visits, month-over-month change, visit duration, pages per visit, bounce rate, device split and the top countries with their shares and changes. Before a project is revealed the figures come as bands and the global, country and industry ranks are withheld, because a rank identifies the site outright; after a reveal the ranks are included, and precision: exact returns exact values instead of bands. Costs the base price plus the audience price for every project whose audience your organization does not already hold, and with precision: exact a surcharge for every revealed project on every call; a project without an audience layer comes back with profile null and is charged neither the part nor the exact surcharge. Ask in bands first, and for exact values only when your user needs exact numbers.
Request
Responses
- 200
- 400
- 401
- 402
- 403
- 409
- 413
- 415
- 429
- 500
- 503
The tool's answer, or with estimate: true its estimate, whose data is a Quote holding quote_token
Response Headers
The request's id: quote it when you write to Megido support
The request cannot be served as sent: bad_request, invalid_params, limit_exceeded, invalid_quote_token, unknown_filter_value
Response Headers
The request's id: quote it when you write to Megido support
No key, or a key the API does not take: unauthorised
Response Headers
The request's id: quote it when you write to Megido support
Bearer realm="megido": send an API key of your organization as a Bearer token
Not enough credits: insufficient_balance
Response Headers
The request's id: quote it when you write to Megido support
Not allowed for your organization or your key: org_suspended, coverage_exceeded
Response Headers
The request's id: quote it when you write to Megido support
In conflict with the state of a quote, the corpus or a task: quote_expired, quote_spent, quote_outdated, confirmation_required, corpus_updated
Response Headers
The request's id: quote it when you write to Megido support
The body is larger than the API takes: bad_request
Response Headers
The request's id: quote it when you write to Megido support
The body is not sent as application/json: bad_request
Response Headers
The request's id: quote it when you write to Megido support
Too many calls: rate_limited
Response Headers
The request's id: quote it when you write to Megido support
Seconds to wait before calling again; sent with rate_limited and lock_timeout only
The call failed on Megido's side: internal_error
Response Headers
The request's id: quote it when you write to Megido support
Not available just now: service_unavailable, lock_timeout, tool_unavailable
Response Headers
The request's id: quote it when you write to Megido support
Seconds to wait before calling again; sent with rate_limited and lock_timeout only