TAB Data: Campaign Updates

We typically refresh all ongoing campaigns once a day, a store a daily record of the most important funding and status fields. Each line in the updates file corresponds to the campaign identified by the UUID (actually this corresponds to "identifiers.uuid" in the campaigns schema).

Key Description Example
uuid UUID of the associated campaign api-50-my-campaign
date

Date that these fields were updated from the platform

2015-01-01T00:00:00.0Z
funding_status

TAB-defined campaign funding status

  • funded: Campaign is funded i.e has reached it's goal within the required timeline
  • failed: Campaign failed. This may be because it didn't meet it's goal within the required timeline or was cancelled.
  • not_yet_funded: Campaign is ongoing and has not yet reached it's funding target
  • unknown: The campaign status is unknown. This is usually when either funding amounts or timelines are not made available by the platform
funded_ended
loan_status

Normalised status of a loan (loan campaigns only)

repaid
principal_repaid

For loans only: the amount repaid from the principal (i.e 'goal')

12345
goal

Campaign goal (i.e target), in the campaign-specified currency. Note that this should be the current goal, which may well be a 'stretch goal' if the initial goal was met

1234
min_goal

The minimum target required before the campaign can be deemed successful. Generally this is only relevant for certain 'Reward' or 'Charity' type projects where the project need not raise the full amount to be successful, as opposed to an 'all or nothing' style campaign

1234
goal_fx.USD

Goal in USD

goal_fx.JPY

Goal in JPY

goal_fx.GBP

Goal in GBP

goal_fx.EUR

Goal in EUR

raised

The total amount raised to date, in the campaign currency.

1000
raised_fx.USD

Amount raised in USD

raised_fx.JPY

Amount raised in JPY

raised_fx.GBP

Amount raised in GBP

raised_fx.EUR

Amount raised in EUR

funders

The total number of funders (i.e backers) contributing to this campaign