External Spins Data Network (SDN) API Documentation Home

 

Contents

Benefits of the SPINS EXTERNAL API

  • Provides clients with large data needs easy access to point of sale data, eliminating manual extracts from Satori.

  • Clients will have real-time access each period to SPINS data updates.

  • Update client’s data warehouse and reporting platforms in your preferred technology.

  • API built using modern and easy to use GraphQL language that allows clients to only request what they need and in the shape they want.

  • Available output formats: Parquet, JSON, or CSV.

 

Current Capabilities

  • Latest 3 yrs. of SPINS POS data - Market Level Data

  • 100+ core measures (details below)

  • Standard time periods*: 1/4/12/24/52, plus YAGO, 2YAGO, Prior Period

    • *for published period data

  • Over 500 core SPINS Attributes

  • Supports Time, Time + Product aggregation

  • Trended Time

  • Supports asynchronous requests

  • Custom Groups passthrough from SATORI

Access to data is based on a client’s subscription with SPINS

Future Planned Capabilities

(not in priority order)

  • Geography aggregation

  • Additional measures

  • Additional SPINS attribution

  • Support for smaller synchronous requests

  • Latest 3 yrs. of SPINS POS data - Store Level Data

  • Addition of other SPINS data assets based on client’s subscription (i.e. E-comm data, new channels)

 

Demo Video

Final.mov

 

image-20240110-200337.png

Current Available Metrics

(126 as of 10/28/2024)

  • averageItemsSelling

  • averagePercentAllCommodityVolume

  • averagePercentAllCommodityVolumeAnyPromotion

  • averagePercentAllCommodityVolumeNonPromotion

  • averageRetailPrice

  • averageRetailPriceAnyDisplay

  • averageRetailPriceAnyFeature

  • averageRetailPriceDisplayOnly

  • averageRetailPriceFeatureAndDisplay

  • averageRetailPriceFeatureOnly

  • averageRetailPriceEquivalentUnits

  • averageRetailPriceNonPromotion

  • averageRetailPricePercentDiscountAnyPromotion

  • averageRetailPricePromotion

  • averageRetailPriceSpecialPack

  • averageRetailPriceTemporaryPriceReduction

  • averageWeeklyBaseDollarsPerStorePerItem

  • averageWeeklyBaseDollarsPerStoreSelling

  • averageWeeklyBaseEquivalentUnitsPerStorePerItem

  • averageWeeklyBaseEquivalentUnitsPerStoreSelling

  • averageWeeklyBaseUnitsPerStorePerItem

  • averageWeeklyBaseUnitsPerStoreSelling

  • averageWeeklyDollars

  • averageWeeklyDollarsPerStoreSelling

  • averageWeeklyDollarsPerStoreSellingPerItem

  • averageWeeklyDollarsSalesPerMillion

  • averageWeeklyEquivalentUnits

  • averageWeeklyEquivalentUnitsPerStoreSellingPerItem

  • averageWeeklyEquivalentUnitsSalesPerMillion

  • averageWeeklyTotalDistributionPoints

  • averageWeeklyUnits

  • averageWeeklyUnitsPerStoreSelling

  • averageWeeklyUnitsPerStoreSellingPerItem

  • averageWeeklyUnitsSalesPerMillion

  • baseAverageRetailPrice

  • baseAverageRetailPriceEquivalentUnits

  • baseAverageRetailPricePromotion

  • baseAverageRetailPricePromotionEquivalentUnits

  • baseDollars

  • baseDollarsPerStoreSelling

  • baseDollarsPerStoreSellingPerItem

  • baseDollarsPromotion

  • baseDollarsSalesPerMillion

  • baseEquivalentUnits

  • baseEquivalentUnitsPerStoreSelling

  • baseEquivalentUnitsPerStoreSellingPerItem

  • baseEquivalentUnitsPromotion

  • baseEquivalentUnitsSalesPerMillion

  • baseUnits

  • baseUnitsPerStoreSelling

  • baseUnitsPerStoreSellingPerItem

  • baseUnitsPromotion

  • baseUnitsSalesPerMillion

  • dollars

  • dollarsAnyDisplay

  • dollarsAnyFeature

  • dollarsDisplayOnly

  • dollarsFeatureAndDisplay

  • dollarsFeatureOnly

  • dollarShareCategory

  • dollarShareDepartment

  • dollarShareSubcategory

  • dollarsNonPromotion

  • dollarsPercentPromotion

  • dollarsPerStoreSelling

  • dollarsPerStoreSellingPerItem

  • dollarsPromotion

  • dollarsSalesPerMillion

  • dollarsSalesPerMillionPerItem

  • dollarsSalesPerPointOfDistribution

  • dollarsSpecialPack

  • dollarsTemporaryPriceReduction

  • dollarsTotalDistributionPoints

  • equivalentUnits

  • equivalentUnitsNonPromotion

  • equivalentUnitSalesPerMillionPerItem

  • equivalentUnitShareCategory

  • equivalentUnitShareDepartment

  • equivalentUnitShareSubcategory

  • equivalentUnitsPercentPromotion

  • equivalentUnitsPerStoreSelling

  • equivalentUnitsPerStoreSellingPerItem

  • equivalentUnitsPromotion

  • equivalentUnitsSalesPerMillion

  • equivalentUnitsSalesPerPoint

  • equivalentUnitsTotalDistributionPoints

  • household

  • incrementalDollars

  • incrementalEquivalentUnits

  • incrementalUnits

  • markdownDollars

  • marketAllCommodityVolume

  • maxPercentAllCommodityVolume

  • maxPercentAllCommodityVolumeAnyPromotion

  • maxPercentAllCommodityVolumeNonPromotion

  • numberOfStores

  • numberOfStoresSelling

  • numberOfWeeksSelling

  • percentOfStoresSelling

  • population

  • totalDistributionPoints

  • totalDistributionPointsAnyPromotion

  • totalDistributionPointsNonPromotion

  • units

  • unitsAnyDisplay

  • unitsAnyFeature

  • unitsDisplayOnly

  • unitsFeatureAndDisplay

  • unitsFeatureOnly

  • unitShareCategory

  • unitShareDepartment

  • unitShareSubcategory

  • unitsNonPromotion

  • unitsPercentPromotion

  • unitsPerStoreSelling

  • unitsPerStoreSellingPerItem

  • unitsPromotion

  • unitsSalesPerMillion

  • unitsSalesPerMillionPerItem

  • unitsSalesPerPointOfDistribution

  • unitsSpecialPack

  • unitsTemporaryPriceReduction

  • unitsTotalDistributionPoints

  • weightWeeks

  • weightWeeksAnyPromotion

  • weightWeeksNonPromotion

Access to data is based on a client’s subscription with SPINS

image-20240110-200805.png

Current Available Attributes

(575 as of 8/14/2024)

  • age

  • alcoholByVolume

  • animalType

  • beerType

  • brand

  • brandPositioning

  • category

  • certifiedAmericanHeartAssociationHeartCheck

  • certifiedBCorporation

  • certifiedDetoxProjectGlyphosateResidueFree

  • certifiedFairTradeAmerica

  • certifiedFairTradeUsa

  • certifiedGreenerWorldAnimalWelfare

  • certifiedGreenerWorldGrassfed

  • certifiedGreenerWorldNonGmo

  • certifiedMarineStewardshipCouncil

  • certifiedNonGmoProjectVerified

  • certifiedPaleoFoundationGrainFree

  • certifiedPaleoFoundationKeto

  • certifiedPaleoFoundationPaleo

  • certifiedPaleoFoundationPaleoFriendly

  • certifiedPaleoFoundationPaleoVegan

  • certifiedPlantBasedFoodsAssociation

  • certifiedUpcycled

  • certifiedWholeGrainsCouncil

  • chocolateType

  • company

  • customGroupName

  • department

  • description

  • diaperSize

  • dietAipDiet

  • dietDashDiet

  • dietFodmap

  • dietGoodFats

  • dietHeartHealthyFda

  • dietKeto

  • dietKetoHighFat

  • dietMediterraneanDiet

  • dietMindDiet

  • dietPaleo

  • dietPescatarian

  • dietPlantBased

  • dietPlantBasedProtein

  • dietPlantBasedWholeFood

  • dietStrongBones

  • dietVegan

  • dietVegetarian

  • dietWhole30Friendly

  • eatingOccasion

  • endDate

  • equivalentUnitSize

  • fairTrade

  • flavor

  • form

  • functionalIngredient

  • gender

  • geography

  • healthFocus

  • holidayPositioned

  • ingredientAcacia

  • ingredientAcai

  • ingredientAcerolaCherry

  • ingredientAcesulfameK

  • ingredientAcetylLCarnitine

  • ingredientAdaptogens

  • ingredientAddedBeanProtein

  • ingredientAddedChiaProtein

  • ingredientAddedChickpeaProtein

  • ingredientAddedDhaOmega3

  • ingredientAddedEpaOmega3

  • ingredientAddedFavaBeanProtein

  • ingredientAddedHempProtein

  • ingredientAddedMungBeanProtein

  • ingredientAddedPeaProtein

  • ingredientAddedPumpkinSeedProtein

  • ingredientAddedRiceProtein

  • ingredientAddedSachaInchiProtein

  • ingredientAddedSoyProtein

  • ingredientAddedWatermelonSeedProtein

  • ingredientAddedWheyProtein

  • ingredientAgaveNectar

  • ingredientAllulose

  • ingredientAlmond

  • ingredientAluminumSalts

  • ingredientAmaranth

  • ingredientAncientGrains

  • ingredientAnimalDerived

  • ingredientAppleCiderVinegar

  • ingredientArtificialColors

  • ingredientArtificialFlavors

  • ingredientArtificialPreservatives

  • ingredientArtificialSweeteners

  • ingredientAscorbicAcid

  • ingredientAshwagandha

  • ingredientAspartame

  • ingredientAstragalus

  • ingredientAzodicarbonamide

  • ingredientBacopa

  • ingredientBakuchiol

  • ingredientBarley

  • ingredientBasil

  • ingredientBeefAndDerivatives

  • ingredientBeePollen

  • ingredientBeePropolis

  • ingredientBenzoates

  • ingredientBerberine

  • ingredientBha

  • ingredientBhaAndBht

  • ingredientBht

  • ingredientBitterMelon

  • ingredientBlackstrapMolasses

  • ingredientBrazilNut

  • ingredientBrominatedVegetableOil

  • ingredientBrownRiceSyrup

  • ingredientBuckwheat

  • ingredientCaffeine

  • ingredientCaffeineEnergy

  • ingredientCaliforniaPoppy

  • ingredientCamuCamu

  • ingredientCaneSugar

  • ingredientCaramelColor

  • ingredientCarbonBlack

  • ingredientCarmineCochineal

  • ingredientCarobBeanGum

  • ingredientCarrageenan

  • ingredientCarrot

  • ingredientCasein

  • ingredientCashew

  • ingredientCelery

  • ingredientCellulose

  • ingredientCelluloseGum

  • ingredientCerealGrain

  • ingredientCharcoal

  • ingredientChiaSeed

  • ingredientChickenAndDerivatives

  • ingredientChicory

  • ingredientChlorella

  • ingredientChondroitin

  • ingredientChromium

  • ingredientCinnamon

  • ingredientCitricAcid

  • ingredientCocoa

  • ingredientCoconut

  • ingredientCoconutSugar

  • ingredientCoenzymeQ10

  • ingredientCoffeeFruit

  • ingredientCollagen

  • ingredientColloidalOatmeal

  • ingredientColorBlueNo1

  • ingredientColorBlueNo2

  • ingredientColorGreenNo3

  • ingredientColorOrangeB

  • ingredientColorRedNo3

  • ingredientColorRedNo40

  • ingredientColorYellowNo5

  • ingredientColorYellowNo6

  • ingredientCoriander

  • ingredientCorn

  • ingredientCornSyrup

  • ingredientDairy

  • ingredientDatem

  • ingredientDateSugar

  • ingredientEchinacea

  • ingredientEdta

  • ingredientEggAllergen

  • ingredientElderberry

  • ingredientEleuthero

  • ingredientErythorbicAcid

  • ingredientEthoxyquin

  • ingredientFarro

  • ingredientFishAllergen

  • ingredientFishOil

  • ingredientFlavorings

  • ingredientFlaxSeed

  • ingredientFruitJuiceConcentrates

  • ingredientGaba

  • ingredientGarlic

  • ingredientGelatin

  • ingredientGinger

  • ingredientGinkgoBiloba

  • ingredientGinseng

  • ingredientGlucomannan

  • ingredientGlucosamine

  • ingredientGluten

  • ingredientGojiBerry

  • ingredientGrain

  • ingredientGreenCoffeeBean

  • ingredientGreenLippedMussel

  • ingredientGreenTea

  • ingredientGuarana

  • ingredientGuarGum

  • ingredientGuggul

  • ingredientGums

  • ingredientGymnemaSylvestre

  • ingredientHazelnut

  • ingredientHempSeed

  • ingredientHighFructoseCornSyrup

  • ingredientHolyBasil

  • ingredientHoney

  • ingredientHuperzine

  • ingredientHyaluronicAcid

  • ingredientHydrogenatedStarchHydrolysate

  • ingredientInsectProtein

  • ingredientInulin

  • ingredientIsomalt

  • ingredientKamut

  • ingredientKava

  • ingredientKeratin

  • ingredientKonjac

  • ingredientKrillOil

  • ingredientLactitol

  • ingredientLactose

  • ingredientLemonBalm

  • ingredientLTheanine

  • ingredientLucumaSweetener

  • ingredientMaca

  • ingredientMacadamiaNut

  • ingredientMagnoliaBark

  • ingredientMajor9AllergenFree

  • ingredientMaltitol

  • ingredientMaltodextrin

  • ingredientManukaHoney

  • ingredientMapleSyrup

  • ingredientMatcha

  • ingredientMelatonin

  • ingredientMilkAllergen

  • ingredientMillet

  • ingredientMolluscAndDerivatives

  • ingredientMonkfruit

  • ingredientMoringa

  • ingredientMsg

  • ingredientMsm

  • ingredientMucunaPruriens

  • ingredientMycoprotein

  • ingredientNaturalLowCalorieSweeteners

  • ingredientNaturalSweeteners

  • ingredientNeotame

  • ingredientNervines

  • ingredientNightshades

  • ingredientNitratesAndNitrites

  • ingredientNonAnimalDairyProtein

  • ingredientNootropics

  • ingredientOat

  • ingredientOctinoxate

  • ingredientOnion

  • ingredientOnlyNaturallySweetened

  • ingredientOregano

  • ingredientOxybenzone

  • ingredientPalmOil

  • ingredientParaben

  • ingredientParsley

  • ingredientPassionflower

  • ingredientPea

  • ingredientPeanutAllergen

  • ingredientPecan

  • ingredientPectin

  • ingredientPetroleum

  • ingredientPhosphateIngredients

  • ingredientPhosphatidylSerine

  • ingredientPhthalate

  • ingredientPineNut

  • ingredientPistachio

  • ingredientPlantSterols

  • ingredientPolyethyleneGlycol

  • ingredientPoppySeed

  • ingredientPorkAndDerivatives

  • ingredientPotassiumBrominate

  • ingredientPotassiumSorbate

  • ingredientPrebiotics

  • ingredientProbiotics

  • ingredientPropyleneGlycol

  • ingredientPropylGallate

  • ingredientQuinoa

  • ingredientRedYeastRice

  • ingredientRetinol

  • ingredientRhodiolaRosea

  • ingredientRice

  • ingredientRosehips

  • ingredientRoyalJelly

  • ingredientRye

  • ingredientSaccharin

  • ingredientSalicylicAcid

  • ingredientSalmonOil

  • ingredientSchisandra

  • ingredientSeaweedAndAlgae

  • ingredientSesameAllergen

  • ingredientShellfishAllergen

  • ingredientSilicone

  • ingredientSkullcap

  • ingredientSodiumBenzoate

  • ingredientSodiumLaurylSulfate

  • ingredientSodiumMetabisulfite

  • ingredientSodiumPhosphate

  • ingredientSorbicAcid

  • ingredientSorghum

  • ingredientSorghumSyrup

  • ingredientSoyAllergen

  • ingredientSpirulina

  • ingredientStevia

  • ingredientSucralose

  • ingredientSugarAlcoholErythritol

  • ingredientSugarAlcoholMannitol

  • ingredientSugarAlcohols

  • ingredientSugarAlcoholSorbitol

  • ingredientSugarAlcoholXylitol

  • ingredientSugars

  • ingredientSulfites

  • ingredientSunflowerSeed

  • ingredientSuperfoods

  • ingredientSuperFruits

  • ingredientSuperGreens

  • ingredientSuperMushrooms

  • ingredientTalc

  • ingredientTapiocaSolubleFiber

  • ingredientTaurine

  • ingredientTbhq

  • ingredientTeaTreeOil

  • ingredientTeff

  • ingredientTransFat

  • ingredientTreeNutsAllergen

  • ingredientTriclosan

  • ingredientTryptophan

  • ingredientTurmeric

  • ingredientUnsweetened