For AI agents: visit https://docs.mira.co/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Documentation
API Reference
Home
Documentation
API Reference
v3.14
v3.32.1
API Reference
Jump to Content
v3.32.1
Home
Documentation
API Reference
SDK Events
JUMP TO
Mira API
Advertisers
Get Advertiser Collection
get
Post Advertiser Collection
post
Get Advertiser Resource
get
Put Advertiser Resource
put
Delete Advertiser Resource
del
Get Advertiser Collection With IDs
post
Search Advertiser Collection
post
Get Campaign Collection for a particular Advertiser
get
Campaigns
Creates all the required entities for an attribution study.
post
Count number of active campaigns and sum impressions measured.
get
Get Campaign Collection
get
Post Campaign Collection
post
Get Campaign Resource
get
Put Campaign Resource
put
Delete Campaign Resource
del
Get Campaign Collection With IDs
post
Search Campaign Collection
post
Get Source Collection for a particular Campaign
get
Associates a Source to a particular Campaign
put
Dissociates a Source from a particular Campaign
del
Get Study Collection for a particular Campaign
get
Post Study Collection for a particular Campaign
post
Get all source jobs that belong to the sources associated with the campaign
get
Get Source Keys for a particular Campaign
get
Get Survey Collection for a particular Campaign
get
Get all Exports that are associated with the Campaign
get
Get all Export Jobs that are associated with the Exports linked to the Campaign
get
Get demographic results for a Campaign
post
Studies
Get Study Collection
get
Post Study Collection
post
Get Study Resource
get
Put Study Resource
put
Delete Study Resource
del
Get Study Collection With IDs
post
Search Study Collection
post
Submit a study
post
Get the Result for a particular Study
get
Get the result top level stats
get
Get result reports
get
Result query endpoint
post
Results
Get Result Resource
get
Delete Result Resource
del
Get Result Collection
get
Get Result Collection With IDs
post
Delete Result Resource
del
Sources
Get Source Collection
get
Post Source Collection
post
Get Source Resource
get
Put Source Resource
put
Delete Source Resource
del
Get Source Collection With IDs
post
Search Source Collection
post
Post a file to a source
post
Associate a file to a source
post
Get all source jobs that belong to a source
get
Get all source jobs that belong to a user
get
Get a source jobs by id
get
Source Jobs
Exposures
Get Exposure Collection
get
Post Exposure Collection
post
Get Exposure Resource
get
Put Exposure Resource
put
Delete Exposure Resource
del
Get Exposure Collection With IDs
post
Search Exposure Collection
post
Get all exposure jobs that belong to a exposure
get
Get all exposure jobs that belong to a user
get
Get a exposure job by id
get
Exposure Jobs
Properties
Get Properties associated with existing Study
get
Associate a Property with an existing Study
put
Dissociate a Property with a Study
del
Get Property Collection
get
Post Property Collection
post
Put Property Resource
put
Delete Property Resource
del
Get Property Collection With IDs
post
Search Property Collection
post
Fetches a Property
get
Get Pixel Collection for a particular Property
get
Post a Pixel Collection for a particular Property
post
Get Pixel Tags for a particular Property
get
Fetches a Pixel for a particular Property
get
Updates a Pixel for a particular Property
put
Deletes a Pixel for a particular Property
del
Fetches a Pixel tag for a particular Property
get
Get footfall source jobs collection for a particular Property
get
Post Footfall source jobs for a particular Property
post
Get footfall jobs collection for a particular Property
get
Get SDK events for a particular Property
get
Post an SDK event collection for a particular Property
post
Deletes an SDK event for a particular Property
del
Pixels
Property Providers
Get Property Provider Collection
get
Post Property Provider Collection
post
Get Property Provider Resource
get
Put Property Provider Resource
put
Delete Property Provider Resource
del
Get Property Provider Collection With IDs
post
SDK Providers
Get SDK Provider Collection
get
Post SDK Provider Collection
post
Get SDK Provider Resource
get
Put SDK Provider Resource
put
Delete SDK Provider Resource
del
Get SDK Provider Collection With IDs
post
Segments
Get Segment Collection
get
Post Segment Collection
post
Get Segment Resource
get
Put Segment Resource
put
Delete Segment Resource
del
Get Segment Collection With IDs
post
Search Segment Collection
post
Segment Groups
Get Segment Group Collection
get
Post Segment Group Collection
post
Get Segment Group Resource
get
Put Segment Group Resource
put
Delete Segment Group Resource
del
Get Segment Group Collection With IDs
post
Search Segment Group Collection
post
Get Segment Group Segments
get
Post Segment Group Segments
post
Patch Segment Group Segments
patch
Delete Segment Group Segment
del
Segment Classes
Post Segment Classes
post
Segment Providers
Post Providers
post
Segment Transforms
Post Segment Transform Collection
post
Get Segment Transform Collection
get
Get Segment Transform Resource
get
Put Segment Transform Resource
put
Delete Segment Transform Resource
del
Get Segment Transform Collection With IDs
post
Search Segment Transform Collection
post
Audiences
Get Audience Resource
get
Put Audience Resource
put
Delete Audience Resource
del
Get Audience Collection
get
Post Audience Collection
post
Get Audience Collection With IDs
post
Search Audience Collection
post
Taxonomies
Get Taxonomy Collection
get
Get Taxonomy Collection With IDs
post
Get Taxonomy Resource
get
Search Taxonomy Collection
post
Get Taxonomy Children
get
Get Taxonomy Node Resource
get
Search Taxonomy
post
Files
Get Files At Share Link Path
get
Create File At Share Link Path
post
Get File At Share Link Path
get
Delete File At Share Link Path
del
Get File Resource
get
Put File Resource
put
Delete File Resource
del
Get File Collection
get
Post File
post
Get File Collection With IDs
post
Search File Collection
post
Folders
Get Folder Collection
get
Post Folder Collection
post
Get Folder Resource
get
Put Folder Resource
put
Delete Folder Resource
del
Get Folder Collection With IDs
post
Search Folder Collection
post
List Files In Folder
get
Post File To Folder
post
ShareLinks
Get ShareLink Collection
get
Post ShareLink Collection
post
Get ShareLink Resource
get
Delete ShareLink Resource
del
Get ShareLink Collection With IDs
post
Search ShareLink Collection
post
Markets
Get Market Collection
get
Get Market Collection With IDs
post
Get Market Resource
get
Search Market Collection
post
Get Market Collection With External IDs
post
Get Block Groups In Market
get
Get Postal Codes In Market
get
CBSAs
Get CBSA Collection
get
Get CBSA Collection With IDs
post
Get CBSA Resource
get
Search CBSA Collection
post
Get CBSA Collection With External IDs
post
Block Groups
Get Block Group Collection
get
Get Block Group Collection With IDs
post
Get Block Group Resource
get
Search Block Group Collection
post
Get Block Group Collection With External IDs
post
Postal Codes
Get Postal Code Collection
get
Get Postal Code Collection With IDs
post
Get Postal Code Resource
get
Search Postal Code Collection
post
Get Postal Code Collection With External IDs
post
Locations
Get Location Collection
get
Post Location Collection
post
Get Location Resource
get
Put Location Resource
put
Delete Location Resource
del
Get Location Collection With IDs
post
Search Location Collection
post
POI Categories
Get POI Category Collection
get
Get POI Category Collection With IDs
post
Get POI Category Resource
get
Search POI Category Collection
post
POI Chains
Get POI Chain Collection
get
Get POI Chain Collection With IDs
post
Get POI Chain Resource
get
Search POI Chain Collection
post
Feeds
Get Feed Collection
get
Post Feed Collection
post
Get Feed Collection With IDs
post
Get Feed Resource
get
Search Feed Collection
post
Get Feed Segments
get
Post Feed Segments
post
Patch Feed Segments
patch
Delete Feed Segment
del
Roles
Grant Resource Permissions
put
List Resource Groups
get
Create Resource Group
post
Get Resource Group
get
Update Resource Group
put
Delete Resource Group
del
Grant Resource Group Permissions
put
List Resource Group Resources
get
Add Resources To Resource Group
post
Patch Resource Group Resources
patch
Delete Resource Group Resource
del
User
Get User Me
get
Post Users
post
Get Teams
get
Post Teams
post
Get Team By Id
get
Get Team Users
get
Post Team Users
post
Delete Team User
del
AgentMetadata
List User Metadata
get
Post User Metadata
post
Get User Metadata By Key
get
Update User Metadata By Key
put
Delete User Metadata By Key
del
Notifications
Get Notification Collection
get
Post Notification Collection
post
Get Notification Resource
get
Put Notification Resource
put
Delete Notification Resource
del
Get Notification Collection With IDs
post
Search Notification Collection
post
Get Segment Notifications
get
Get Source Notifications
get
Notification Types
Get Notification Type Collection
get
Post Notification Type Collection
post
Get Notification Type Collection With IDs
post
Get Notification Type Resource
get
Footfall Source Jobs
Footfall Jobs
SDK Events
Surveys
Post Survey Collection
post
Get Survey Collection
get
Put Survey Resource
put
Delete Survey Resource
del
Get Survey Resource
get
Get Survey Collection With IDs
post
Search Survey Collection
post
Upload a results snapshot for a Survey
post
Get Result Collection for a particular Survey
get
Query a Survey's results report
post
Query a Survey's results report with its presentation applied
get
Exports
Post Export Collection
post
Get Export Collection
get
Put Export Resource
put
Delete Export Resource
del
Get Export Resource
get
Get Export Collection With IDs
post
Search Export Collection
post
Get Export Jobs for a particular Export
get
Export Jobs
Get all Export Jobs associated with the user.
get
Demographics
Get national demographic metrics
get
Goals
Get Goals event metrics for a particular Property
get
Get Goals collection for a user
get
Get Goals count by health status
get
Verticals
Get Vertical Collection
get
Post Vertical Collection
post
Get Vertical Resource
get
Put Vertical Resource
put
Delete Vertical Resource
del
Get Vertical Collection With IDs
post
Benchmarks
Get metrics for a specific or latest Benchmark
post
Get Benchmark Collection
get
Post Benchmark Collection
post
Get Benchmark Resource
get
Put Benchmark Resource
put
Delete Benchmark Resource
del
Get Benchmark Collection With IDs
post
Geocoding Jobs
Get Geocoding Job Collection
get
Post Geocoding Job Collection
post
Get Geocoding Job Resource
get
Put Geocoding Job Resource
put
Get Geocoding Job Collection With IDs
post
Search Geocoding Job Collection
post
Post a file to a specific geocoding job
post
Switches a geocoding job to complete
post
Buckets
Post Bucket Collection
post
Get Bucket Collection
get
Put Bucket Resource
put
Delete Bucket Resource
del
Get Bucket Resource
get
Get Bucket Collection With IDs
post
Search Bucket Collection
post
Destinations
Post Destination Collection
post
Get Destination Collection
get
Put Destination Resource
put
Delete Destination Resource
del
Get Destination Resource
get
Get Destination Collection With IDs
post
Search Destination Collection
post
Get Exports for a particular Destination
get
Get Export Jobs associated with Exports, linked to a particular Destination
get
AI
Generate AI summary for study data
post
Plans
Post Plan Collection
post
Get Plan Collection
get
Put Plan Resource
put
Delete Plan Resource
del
Get Plan Resource
get
Get Plan Collection With IDs
post
Search Plan Collection
post
Get Source Collection for a particular Plan
get
Associates a Source to a particular Plan
put
Dissociates a Source from a particular Plan
del
Get all source jobs that belong to the sources associated with the plan
get
Get Source Keys for a particular Plan
get
Get demographic results for a Plan
post
Analytics API
Aggs
Get Agg Collection
get
Post Agg Collection
post
Get Agg
get
Update Agg
put
Agg Jobs
Get Agg Job Collection
get
Post Agg Job Collection
post
Get Agg Job
get
Update Agg Job
put
Find Agg Job
post
Analytics
Get Tiles
post
Get Tiles Raw
post
Get Points
post
Get Market Ranker
post
Get Market Ranker Raw
post
Get Market Ranker Xlsx
post
Get Market Ranker Geojson
post
Post Count Endpoint
post
Powered by
Copy Page
SDK Events
Updated 11 months ago
Get Notification Type Resource
Surveys
Updated 11 months ago
Get Notification Type Resource
Surveys
